Jan Tuomi
130 lines
3.6 KiB
Markdown
130 lines
3.6 KiB
Markdown
# SIKWEB 2.0
|
|
|
|
A modern web app using a Django backend and an Angular frontend.
|
|
|
|
## Components
|
|
|
|
### Infoscreen
|
|
|
|
Angular-based slideshow app for the guild room's screens.
|
|
|
|
### Member register
|
|
|
|
Data table app for viewing and modifying the member register, member applications and membership payments.
|
|
|
|
### Web app
|
|
|
|
Mostly static website with an event calendar and news feed.
|
|
|
|
### Coffee scale
|
|
|
|
Shows the current coffee scale status.
|
|
|
|
## Accessing the source
|
|
|
|
### Clone this repository and enter it
|
|
|
|
Set up your SSH key authentication in GitLab Profile Settings. Then clone the repository and checkout the development branch:
|
|
|
|
```
|
|
git clone git@git.sahkoinsinoorikilta.fi:vtmk/web2.0.git
|
|
cd web2.0
|
|
git checkout develop
|
|
```
|
|
|
|
## Windows install instructions
|
|
|
|
See [Windows install instructions](./windows_install.md)
|
|
|
|
## Linux/Mac install instructions
|
|
|
|
See [Linux/Mac install instructions](./linux_install.md)
|
|
|
|
## Initializing data
|
|
|
|
Run the following `manage.py` commands. Do not run these in production without thinking!
|
|
|
|
```
|
|
python manage.py createdefaultadmin # creates an admin user
|
|
python manage.py initialize # creates user groups
|
|
python manage.py createdummydata # creates dummy members to the member register
|
|
```
|
|
|
|
## Running
|
|
|
|
### Use runserver command
|
|
|
|
```
|
|
python manage.py runserver 0.0.0.0:8000
|
|
```
|
|
|
|
Using address `0.0.0.0` will bind to all IP addresses. Using `localhost` will only bind to your machine.
|
|
|
|
### Visit the page
|
|
|
|
Visit [https://localhost:8000](https://localhost:8000) in your browser!
|
|
|
|
## Running in production
|
|
|
|
Run the project in production with gunicorn. Refer to [this page](https://www.digitalocean.com/community/tutorials/how-to-set-up-django-with-postgres-nginx-and-gunicorn-on-ubuntu-16-04) for instructions.
|
|
|
|
Install production dependencies.
|
|
|
|
```
|
|
pip install -r requirements.production.txt
|
|
```
|
|
|
|
## Development workflow
|
|
|
|
When pulling changes from the server, use `rebase` instead of `merge` for a nice and clean linear history.
|
|
|
|
Example of pulling with rebase:
|
|
```
|
|
git pull --rebase
|
|
```
|
|
|
|
When you start working on a feature, create a feature branch for your changes. These feature branches should be prefixed with `feature`.
|
|
|
|
Example of creating a feature branch:
|
|
```
|
|
git checkout -b feature-error-page
|
|
```
|
|
|
|
When your changes are ready and the code works without errors, submit a merge request to `develop` in GitLab. Another developer reviews your changes and runs the merge. Feature branches should be closed on merge.
|
|
|
|
Bugfixes do not need their own feature branches and can be pushed straight to `develop`, but if the fix needs a notable amount of work, it should be done in a `bugfix` branch instead.
|
|
|
|
Merge requests to `master` should be reviewed by multiple developers. Only a moderator can accept merge requests to `master`.
|
|
|
|
### Linting
|
|
|
|
Lint python files using `pycodestyle` with
|
|
|
|
```
|
|
pycodestyle --config=setup.cfg --count .
|
|
```
|
|
|
|
Lint javascript and markdown using `eslint` and `remark` with
|
|
|
|
```
|
|
npm test
|
|
```
|
|
|
|
Use an editor with linting capabilities to write pretty code that passes linting. Examples include _VSCode_, _Atom_ and _Pycharm_.
|
|
|
|
### Unit tests
|
|
|
|
Run unit tests with
|
|
|
|
```
|
|
python manage.py test -v 2
|
|
```
|
|
|
|
Due to the mostly static nature of the project, most elements are difficult to properly unit test. If you write code with actual logic, make sure to write at least one unit or integration test that tests your code's core functionality.
|
|
|
|
Tests are located in `tests.py` under every subproject.
|
|
|
|
### GitLab CI
|
|
|
|
All pushed changes go through the GitLab Continuous Integration, which consists of automated unit testing and linting. Make sure your changes pass both before merging to `develop` or `master`.
|