https://github.com/diaga/squibler_tech_project
https://github.com/diaga/squibler_tech_project
Last synced: 11 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/diaga/squibler_tech_project
- Owner: Diaga
- License: mit
- Created: 2022-02-26T06:10:59.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2022-02-27T14:30:48.000Z (over 4 years ago)
- Last Synced: 2025-02-05T13:34:35.011Z (over 1 year ago)
- Language: Python
- Size: 43 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# 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](https://docs.google.com/document/d/19aeJIJmxPpaad6xSRoT92cCmtR2HvOfE4BulK8_HdF0) for detailed
specifications.
**Docs**: Please view [docs](docs/README.md) folder to read about design and development decisions.
## Getting Started
### Setup using virtualenv
1. Create virtualenv using the below command:
```shell
$ virtualenv venv
```
2. Install requirements
```shell
$ pip install -r requirements.txt
```
3. Test server.
```shell
$ cd src
$ python manage.py test
```
4. Run server. The development server should be live at localhost:8000.
```shell
$ python manage.py runserver
```
### Setup using docker compose
1. Install docker using the [official documentation](https://docs.docker.com/get-docker/)
2. Use the following command to run tests using docker compose:
```shell
$ docker compose -f docker-compose.test.yaml up
```
3. Use the following command to run server. The development server should be live at localhost:8000.
```shell
$ docker compose up
```
## Changelog
Please read [CHANGELOG](CHANGELOG.md) to view development progress.
## License
[MIT](LICENSE)