Skip to content

Commit 2fdeaa3

Browse files
committed
Updated readme for initial scripts
1 parent a3822a0 commit 2fdeaa3

File tree

1 file changed

+11
-25
lines changed

1 file changed

+11
-25
lines changed

README.md

Lines changed: 11 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -23,37 +23,23 @@ Please read the [contributing guidelines](https://github.com/CodeForPhilly/third
2323
You will need to have a working understanding of using a Unix-like system via a terminal or shell and the instructions below use Bash commands.
2424

2525
In order to run this app, you will need to have the following libraries installed on your machine:
26-
- Node: Javascript runtime
27-
- npm: Node Package Manager
28-
- Django: python web framework
29-
- Python 3.9+
26+
- Docker [Install here](https://www.docker.com/products/docker-desktop/)
3027

31-
Note: These installations will not be required locally once we have the project containerized, the container will hand that.
28+
### First time setup
3229

33-
### Create .env file
34-
35-
#### Why a .env?
36-
We will be using a `.env` file to share environment variables with each of the Docker containers and separate our environment variables from our code.
37-
38-
#### Make the actual file
39-
40-
Duplicate the `.env.sample` file and rename it to `.env`
41-
42-
#### Note
43-
44-
The `.env` file is ignored by git and so any changes will have to be communicated to the team to make sure API keys etc. stay aligned from dev to dev.
30+
```sh
31+
./scripts/bootstrap
32+
./scripts/update
33+
# This script will set up everything you need to get started.
34+
```
4535

4636
### Start the servers
4737

48-
To run all servers (React, Django, & PostgreSQL):
4938
```sh
50-
# Build the containers from images
51-
docker-compose build
52-
# Run the servers
53-
docker-compose up
54-
55-
# OR for a single command to do both
56-
docker-compose up --build
39+
# If you haven't updated in a while, run update script.
40+
./scripts/update
41+
# To run all servers (React, Django, & PostgreSQL):
42+
./scripts/server
5743
```
5844

5945
### Port Numbers

0 commit comments

Comments
 (0)