Commit c8b3b748 authored by David Haynes's avatar David Haynes 🙆

Add a few more words to the README

- It's still not great but it's a gradual process
parent 9214318d
Pipeline #3037 passed with stage
in 53 seconds
......@@ -21,33 +21,52 @@ operations on Go links as well as RegisteredUser account management.
### `go_ahead`
`go_ahead` is the ReactJS frontend of the project. It is built with the React
JavaScript framework to allow for rapid development and experimentation. There
is also a lot of interactivty that the framework allows that we can leverage
for a smooth user experience.
## Getting started with contributing
There's a workflow involved with getting started contributing but once you do
it once or twice it'll seem a lot less daunting.
1. React / Webpack
1. Running `go_ahead` | React / Webpack
You'll need node installed.
```sh
npm install -g yarn
yarn
yarn dev
```
This starts a foreground process that will rebuild the React site whenever
there is a change.
2. Running `go_back` | Docker
You'll need Docker and docker-compose installed.
```sh
yarn
yarn dev
```
In another terminal tab from the `yarn` one:
2. Docker
```sh
docker-compose up
```
In another terminal tab:
```sh
docker-compose up
```
3. Misc. | Actually coding
3. Actually coding
All JS changes will require a refresh (Webpack rebuilds the app in the background).
All JS changes will require a refresh (Webpack rebuilds the app in the background).
All Python changes will require a refresh.
All Python changes will require a refresh.
To pull in python dependecies and work in a contained environment we use `pipenv`.
```
pipenv install
pipenv shell
```
4. Deployment of changes
4) Deployment of changes
See me.
\ No newline at end of file
See me.
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment