Skip to content

Commit

Permalink
chore: update README
Browse files Browse the repository at this point in the history
  • Loading branch information
EwoutV authored Mar 14, 2024
1 parent dcff399 commit e3b87ea
Showing 1 changed file with 7 additions and 14 deletions.
21 changes: 7 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,19 +2,12 @@

This application was developed within the framework of the course "Software Engineering Lab 2" within the Computer Science program at Ghent University.

## Development
## Documentation

Run `development.sh`.
It starts the development environment and attaches itself to the output of the backend.
The backend will auto reload when changing a file.
Acces the server by going to `https://localhost/api` for the backend and `https://localhost` for the frontend.
See our wiki at [https://github.com/SELab-2/UGent-7/wiki](https://github.com/SELab-2/UGent-7/wiki) for more detailed information on the project's architecture.

If you change something to one of the docker files run `docker-compose -f development.yml up --build` to rebuild.

### Backend

Instructions for the setup of the Django backend are to be found in `backend/README.md`.

### Frontend

Instructions for the setup of the Frontend backend are to be found in `frontend/README.md`.
A shorter summary for building the project locally can be found here:
- Run `development.sh`.
- It starts the development environment and attaches itself to the output of the backend. The backend will auto reload when changing a file.
- Access the server by going to `https://localhost/api` for the backend and `https://localhost` for the frontend.
- If you change something to one of the docker files run `docker-compose -f development.yml up --build` to rebuild.

0 comments on commit e3b87ea

Please sign in to comment.