forked from Fediversity/Fediversity
47 lines
1 KiB
Markdown
47 lines
1 KiB
Markdown
|
# Fediversity Panel
|
||
|
|
|
||
|
|
The Fediversity Panel is a web service for managing Fediversity deployments with a graphical user interface, written in Django.
|
||
|
|
|
||
|
|
## Development
|
||
|
|
|
||
|
|
- To obtain all tools related to this project, enter the development environment with `nix-shell`.
|
||
|
|
|
||
|
|
If you want to do that automatically on entering this directory:
|
||
|
|
|
||
|
|
- [Set up `direnv`](https://github.com/nix-community/nix-direnv#installation)
|
||
|
|
- Run `direnv allow` in the directory where repository is stored on your machine
|
||
|
|
|
||
|
|
> **Note**
|
||
|
|
>
|
||
|
|
> This is a security boundary, and allows automatically running code from this repository on your machine.
|
||
|
|
|
||
|
|
- Run NixOS integration tests and Django unit tests:
|
||
|
|
|
||
|
|
```bash
|
||
|
|
nix-build -A tests
|
||
|
|
```
|
||
|
|
|
||
|
|
- List all available Django management commands with:
|
||
|
|
|
||
|
|
```shell-session
|
||
|
|
manage
|
||
|
|
```
|
||
|
|
|
||
|
|
- Run the server locally
|
||
|
|
|
||
|
|
```shell-session
|
||
|
|
manage runserver
|
||
|
|
```
|
||
|
|
|
||
|
|
- Whenever you add a field in the database schema, run:
|
||
|
|
|
||
|
|
```console
|
||
|
|
manage makemigrations
|
||
|
|
```
|
||
|
|
|
||
|
|
Then before starting the server again, run:
|
||
|
|
|
||
|
|
```
|
||
|
|
manage migrate
|
||
|
|
```
|