This is the monorepo we'll be using to contain all the code related to the empowered indian platform.
Work in progress:
- As of now, the frontend and backend components are available in their respective folders.
- The goal is to turn into a monorepo where frontend and backend will be apps sharing the same set of packages and dev tools & ergonomics.
- We are actively gathering data on MLALADS and plan to begin development around this dataset soon.
Initial plan is to have something like this,
.github/
.vscode/
apps/
frontend/
backend/
packages/
features/
data-access/
ui/
utils/
tooling/
....
Contributions are welcome. But please note that before raising a pull request, make sure to open an issue first. This way, we can streamline the discussions on the issue & proposed solutions and keep things organized. PRs without any issue will be closed without any consideration.
- Node.js 18+
- Docker and Docker Compose (recommended for MongoDB)
The easiest way to get started is using Docker Compose for the database:
-
Start MongoDB and Mongo Express (database admin UI)
docker-compose up -d
This will start:
- MongoDB on
localhost:27017 - Mongo Express web UI on
http://localhost:8081(username:admin, password:admin)
- MongoDB on
-
Set up backend
cd backend cp .env.example .env npm install npm run devThe default
.envis already configured to connect to the Docker MongoDB. -
Set up frontend
cd frontend cp .env.example .env npm install npm run dev -
Stop services
docker-compose down
-
Reset database (removes all data)
docker-compose down -v
If you prefer not to use Docker, you can use MongoDB Atlas or a local MongoDB installation. See the detailed documentation:
- FE: README CONTRIBUTING
- BE: README CONTRIBUTING
- AGPL-3.0 — see LICENSE.