Fig Finance
The full API documentation can be found by following the link below:
Via Cloning The Repository
# Clone the app
git clone https://github.com/vic3king/FIG.git
# Switch to directory
cd FIG
# Install Package dependencies
npm install
# create a .env file and make a clone of the .example.env
touch .env
#Start the application
npm run start:dev
#View the application
navigate to localhost:3000 to view the applicationnpm run test- NodeJS is a JavaScript runtime built on Chrome's V8 JavaScript engine
- Express JS A minimalist web framework
- MongoDB The database for modern applications.
- MongooseORM Elegant mongodb object modeling for node.js
- Jest Jest is a delightful JavaScript Testing Framework with a focus on simplicity.
- Supertest SuperAgent driven library for testing HTTP servers
- ESLint provides a pluggable linting utility for JavaScript.
- Prettier Prettier is an opinionated code formatter with support for Javascript
- Airbnb - Airbnb maintains a very popular JavaScript Style Guide
- Babel A JavaScript compiler for converting codes written in ES6 or JSX to ES5 that is supported by many browsers
| Request | End Point | Action |
|---|---|---|
| POST | / | Welcome screen |
| POST | /v1/auth/login/ | Login a user |
| POST | /v1/auth/register/ | Register a user |
| PATCH | /v1/users/interests/ | updates a users interests |
| POST | /v1/events/create/ | Create a new event |
| GET | /v1/events | Get all events |
| GET | /v1/events/recommended | Gets a users recommended events based on the users interests |
- Akaniru Victory - Initial work - Vic3King