osscameroon / onacut

Onacut is web application that notifies users of electricity, water or internet outage in their location

onacut237

Project setup backend

REQUIREMENTS

• python (3.x recommended) & pip (>= 22 recommended)
• docker
• make (a command line tool to run Makefile commands)

HOW TO SET UP

# Put appropriate parameters inside .env.example
make install-deps

HOW TO LAUNCH

DEV

make run

# To run tests
make test

# formating
make lint

PROD

Or Using Docker

# This will install and run your project on port 8000
make docker-run

To run the backend [fastapi]

• Install the virtualenv

• Run the backend

make run

Project setup frontend

REQUIREMENTS

• node & npm
• docker
• make (a command line tool to run Makefile commands)

HOW TO SET UP

# Put appropriate parameters inside .env.example
make install-deps

# or with npm
npm install

HOW TO LAUNCH

DEV

make run

# or with npm
npm start

# To run tests
make test

PROD

Or Using Docker

make serve

# or with npm
npm run serve

# This will install and run your project on port 3000
make docker-run

To launch the frontend, we need Node installed and npm

• Install the dependencies

npm install

Compiles and hot-reloads for development

npm run start 

Compiles and minifies for production

npm run build

NB: To launch the frontend, you should launch the backend first.

Screenshots

Illustrative video of the project

simplescreenrecorder-2022-08-15_10.40.49.mp4