Cloud Book Writer Platform Backend

A platform where users can write books and save it on cloud without keeping files stored locally. Users can collaborate with other writers as well on the same book without thinking too much about the collaboration process.

Requirements: Please see attached Google Docs link for detailed specifications.

Docs: Please view docs folder to read about design and development decisions.

Getting Started

Setup using virtualenv

Create virtualenv using the below command:

$ virtualenv venv

Install requirements

$ pip install -r requirements.txt

Test server.

$ cd src
$ python manage.py test

Run server. The development server should be live at localhost:8000.

$ python manage.py runserver

Setup using docker compose

Install docker using the official documentation
Use the following command to run tests using docker compose:

$ docker compose -f docker-compose.test.yaml up

Use the following command to run server. The development server should be live at localhost:8000.

$ docker compose up

Changelog

Please read CHANGELOG to view development progress.

License