-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
sorting goals list and adding readme local run instructions
- Loading branch information
1 parent
e1d462c
commit 1e0ef5a
Showing
2 changed files
with
19 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,11 @@ | ||
# parakeet | ||
|
||
🦜 An app to help your students stay motivated to practice their craft and track their progress, set new goals and work towards achieving them! | ||
|
||
## Running Locally | ||
|
||
This application uses Docker to run its various components. In order to spin up this application locally: | ||
|
||
1. Clone the repository: `git clone https://github.com/sdevalapurkar/parakeet.git`. | ||
2. From the root directory of the project, run: `docker-compose up -d`. | ||
3. Go to `localhost:3000` and the application should be running ready to be used :) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters