https://github.com/verencelola/quexl
This is a Feverr-Like Django backend
https://github.com/verencelola/quexl
django django-application django-channels django-rest-framework pytest-django
Last synced: 4 months ago
JSON representation
This is a Feverr-Like Django backend
- Host: GitHub
- URL: https://github.com/verencelola/quexl
- Owner: verenceLola
- License: mit
- Created: 2019-10-04T05:57:21.000Z (over 6 years ago)
- Default Branch: develop
- Last Pushed: 2023-08-18T14:29:23.000Z (almost 3 years ago)
- Last Synced: 2025-10-19T11:49:37.384Z (8 months ago)
- Topics: django, django-application, django-channels, django-rest-framework, pytest-django
- Language: Python
- Size: 491 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 20
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Quexl
[](https://codeclimate.com/github/verenceLola/Quexl/maintainability)
[](https://travis-ci.com/verenceLola/Quexl)
[](https://codecov.io/gh/verenceLola/Quexl)
[](https://codeclimate.com/github/verenceLola/Quexl/test_coverage)
[](https://github.com/psf/black)
This is an online marketplace for freelance services.
[](https://app.getpostman.com/run-collection/2acad8ef40948488fbab#?env%5BQuexl%5D=W3sia2V5IjoiYmFzZV91cmwiLCJ2YWx1ZSI6IiIsImVuYWJsZWQiOnRydWV9LHsia2V5IjoidG9rZW4iLCJ2YWx1ZSI6IiIsImVuYWJsZWQiOnRydWV9XQ==)
The Application has been documented using Postman Documentation tht can be viewed [here.](https://documenter.getpostman.com/view/4146974/SVtVVp1U?version=latest)
## Setting Up the Application Locally
### Installing PostgreSQL
- PostgreSQL server is required by the application for the application to run. To use the local PostgreSQL server, ensure you have PostgreSQL [installed](https://www.postgresql.org/docs/12/tutorial-install.html) and running. ensure you add the server PostgreSQL connection URL to your .env file
``` bash
DATABASE_URL=postgres://:@:/ # postgres://postgres@127.0.0.1:5432 if no username or password configured, or just a remote host's URL
```
### Setup VirtualEnvironment
- Setup Pyhton virtual environment by running `python3 -m venv venv`
- Activate the virtual environment by running `source venv/bin/activate`
### Install Application Dependencies
- Run the following command to install application dependencies `pip install -r requirements.txt`
- After installing the dependencies, add the necessary environmental variables required by the application. Sample environmental varials are:
```bash
DEBUG=True
DATABASE_URL=postgres://:@:/
SECRET_KEY="611=df5*i4evgbpu3)$th%=##=kw#h#@8zomsn1$eo6f^uv74$" # sample SECRET_KEY
```
- Add the above variables in a file name `.env` in the root of the project
### Perform Initial Migrations
- To ensure that the database tables are properly configured, run migrations by running `./manage.py migrate` at the root of the project
### Start the Server
- After successfully performing migrations, the server can be started by running `./manage.py runserver` at the root of the project
### Running Tests
- To run unit test, [pytest](https://docs.pytest.org/en/latest/) is used. Run `pytest` at the root of the project
### Contributing
- Before contributing, ensure to install `pre-commit` by running in the root of the application after application setup.
``` bash
$ pre-commit init
```
This is to enforce coding styles.
## Deployments and Releases
- The project had been deployed to Heroku. To view the various versions of the deployed apps, go [here](https://github.com/verenceLola/Quexl/deployments)