Skip to content

Commit

Permalink
Updated README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Kraust committed Feb 24, 2024
1 parent 5556fcd commit 60a161e
Showing 1 changed file with 4 additions and 9 deletions.
13 changes: 4 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,27 +4,22 @@ django backend for OSCR
OSCR-server is a backend for [OSCR](https://github.com/STOCD/OSCR/tree/main) with the intent
of recording combat log data.

There is a test server located at [kraust-oscr.koyeb.app](https://kraust-oscr.koyeb.app/swagger/)
There is a test server located at [https://oscr-server.vercel.app/](https://oscr-server.vercel.app/)

# Requirements
see requirements.txt

# Running
## Development
```bash
python3 manage.py migrate
ENABLE_DEBUG=y python3 manage.py migrate
ENABLE_DEBUG=y python3 manage.py runserver
```

## Production

This Project should be deployable to cloud docker providers, however OSCR-server
is not currently production ready and needs to address its DB backend first.

- Currently we use the default sqlite provider which is not acceptable in cloud
deployments. In the future we will move to postgres.

- Logs may also be stored in DB instead of on the local FS.
This project has been tested to be deployable to [vercel](https://vercel.com) and includes
Support for both vercel's blob and postgres integrations.

# Create the superuser (for django admin):

Expand Down

1 comment on commit 60a161e

@vercel
Copy link

@vercel vercel bot commented on 60a161e Feb 24, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please sign in to comment.