Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sirodoht/mal
Wiki.
https://github.com/sirodoht/mal
django dokku minimal wiki
Last synced: 5 days ago
JSON representation
Wiki.
- Host: GitHub
- URL: https://github.com/sirodoht/mal
- Owner: sirodoht
- License: mit
- Created: 2020-02-09T15:34:56.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2020-04-21T23:24:02.000Z (over 4 years ago)
- Last Synced: 2024-08-01T12:31:06.993Z (3 months ago)
- Topics: django, dokku, minimal, wiki
- Language: JavaScript
- Homepage:
- Size: 206 KB
- Stars: 2
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-starred - sirodoht/mal - Wiki. (django)
README
# mal
Wiki.
## Development
This is a [Django](https://www.djangoproject.com/) codebase. Check out the
[Django docs](https://docs.djangoproject.com/) for general technical documentation.
### Structure
The Django project is `mal`. There is one Django app, `main`, with all business logic.
### Dependencies
Using [venv](https://docs.python.org/3/library/venv.html):
```sh
python3 -m venv venv
source venv/bin/activate
pip install -r requirements.txt
```
This project also uses [pip-tools](https://github.com/jazzband/pip-tools) for
dependencies management.
### Environment variables
You need to create a new file named `.env` in the root of this project once you cloned it.
`.env` should contain the following env variables:
```sh
SECRET_KEY="thisisthesecretkey"
DATABASE_URL="postgres://username:password@localhost:5432/db_name"
EMAIL_HOST_USER="smtp_user"
EMAIL_HOST_PASSWORD="smtp_password"
```
### Database
This project uses PostgreSQL. See above on how to configure access to it using
the `.env` file.
There is no need to create manually one if you're using Docker and
[Docker Compose](https://docs.docker.com/compose/). Run this to spin up the
database in the background:
```sh
docker-compose up -d db
```
The database data will be saved in a gitignored directory, `db_data`, in the root of
the project.
To create the database schema:
```sh
python manage.py migrate
```
### Serve
To run the Django development server:
```sh
python manage.py runserver
```
Or, if you prefer to run the web server under Docker:
```sh
docker-compose up web
```
In which case, `DATABASE_URL` in `.env` should be like this:
```sh
DATABASE_URL="postgres://postgres:postgres@db:5432/postgres"
```
## Testing
```sh
python manage.py test
```
## Code linting & formatting
```sh
black . && isort -y && flake8
```
## Deployment
Deployment [is configured](uwsgi.ini) using the production-grade
[uwsgi](https://uwsgi-docs.readthedocs.io/en/latest/) server.
```sh
uwsgi --ini=uwsgi.ini -H venv/
```
You also need to populate your shell environment:
```sh
export SECRET_KEY="thisisthesecretkey"
export DATABASE_URL="postgres://username:password@localhost:5432/db_name"
export EMAIL_HOST_USER="smtp_user"
export EMAIL_HOST_PASSWORD="smtp_password"
```
## Dokku
This project is also configured to deploy to [dokku](http://dokku.viewdocs.io/dokku/).
* [Procfile](Procfile): app init command
* [app.json](app.json): predeploy tasks
* [DOKKU_SCALE](DOKKU_SCALE): process scaling
## License
This software is licensed under the MIT license.
For more information, read the [LICENSE](LICENSE) file.