diff options
| author | Terry Truong <terry06890@gmail.com> | 2022-07-11 13:19:18 +1000 |
|---|---|---|
| committer | Terry Truong <terry06890@gmail.com> | 2022-07-11 13:19:18 +1000 |
| commit | 7a28e15874796b3becf97c0193575d906d0cfd01 (patch) | |
| tree | 20c679fb7167c18009a697f0d3db7bed1d1b409c /README.md | |
| parent | 5fe71ea7b9d9a5d2dc6e8e5ce5b9193629eed74d (diff) | |
Update backend documentation
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 7 |
1 files changed, 1 insertions, 6 deletions
@@ -18,7 +18,7 @@ managed using [Pip](https://pypi.org/project/pip). Tree data is stored using [Sq - **package.json**: Contains npm project information, such as package dependencies. - **package-lock.json**: Auto-generated by npm. Used for replicable installations. - **LICENCE.txt**: This project's license (MIT). -- **.gitignore**: Lists files to be ignored by Git. +- **.gitignore**: Lists files to be ignored if using [Git](https://git-scm.com/downloads). ### Client & Server - **src**: Contains most of the client-side code. - **index.html**: Holds code for the main page, into which code from 'src' will be included. @@ -36,11 +36,6 @@ Note: Running your own version of the client and server should be straightforward, but generating the database will take a long time. More details are in backend/data/README.md. -### Base Requirements -- **[Python](https://www.python.org/downloads)**: For running server-side code, and generating the database. -- **Pip**: For installing Python packages. Included in the Python download. -- **[Git](https://git-scm.com/downloads)** (optional): For downloading and viewing snapshots of the project. - ### Client Side 1. If you don't have npm or Node.js installed, you can download a Node installer from <https://nodejs.org/en/download>, which includes npm. This project was coded using version 16. |