README.md

Project Title

A simple personality test application

Description

The application is used to discover someone's personality.

Frontend: ReactJS with Material UI Backend: Expressjs

Getting Started

Dependencies

Contained in package.json file

Built With

React

Node

MongoDB

Express

Installing

Below is an example of how you can instruct your audience on installing and setting up your app. This template doesn't rely on any external dependencies or services.

Clone the repo

Install NPM packages

npm install

Executing program

Input Mongo_URI as an environment variable.

Run the command below in the terminal to run the application (frontend and backend application simultaneously)

lerna run --parallel start

To run the docker application

navigate to the root directory

cd simpersonality

docker-compose build

docker-compose up

To stop the containers

docker-compose stop

Postman Collection

Find the postman collection in the documentation folder in the backend directory

Authors

Contributors names and contact info

ex. Ayo Folami