Repository Boilerplate

A boilerplate that can be used as a template for quickly setting up a repository for a web application with the following stacks:

1. Backend in Django & Django Restframework
2. Frontend in ReactJS
3. Application in React Native
4. Stable Storage in PostgreSQL
5. Warehousing/Lake in MongoDB
6. In-Memory Datasource/ Caching (Frontend Only) in Redis

Setup

The setup procedures are defined as follows

Pre-Requisites

1. Console: BASH
   • GitBASH for Windows
2. Python v3.9
3. NPM v9.6
4. React-JS v9.6
5. React-Native v9.6
6. PostreSQL & PGAdmin
7. MongoDB & MongoDB Compass
8. Redis
9. Crontab

Repository Procurement

git clone https://<personalAccessToken>@github.com/Arkiralor/ProjectBoilerplate.git

How to use the Boilerplate

1. Run the procurement command shown above.
2. Delete the .git directory from the cloned repository.
3. Rename the repository-directory to one that is more appropriate for the purpose of the codebase.
4. Run git init from inside the repository-directory (level-0) to initiate a new repository.
5. Code away...!

Backend Setup

See backend/readme.md

Frontend Setup

See frontend/readme.md

Application Setup

See app/readme.md

PostgreSQL/PGADmin Setup

Details here.

MongoDB/Compass Setup

Details here.

Redis Setup

Details here.

Documentation

Documentation can be viewed in each Tier-1 directory's readme.md file.