Barefoot Nomad API
The full API documentation can be found by following the link below:
http://localhost:4111/v1/api-docs/
Via Cloning The Repository
# Clone the app
git clone https://github.com/vic3king/barefoot.git
# Switch to directory
cd barefoot
# 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:4111 to view the application
npm run test
- NodeJS is a JavaScript runtime built on Chrome's V8 JavaScript engine
- Typescript TypeScript is JavaScript with syntax for types.
- 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
- Joi The most powerful schema description language and data validator for JavaScript.
- GTS gts is Google's TypeScript style guide, and the configuration for our formatter, linter, and automatic code fixer.
- ESLint provides a pluggable linting utility for JavaScript.
- Prettier Prettier is an opinionated code formatter with support for Javascript
- Google Typescript Guide - Style Guide
- Typescript A Typescript compiler for converting codes written in typescript to javascript
Request | End Point | Action |
---|---|---|
POST | / | Welcome screen |
POST | /v1/users/ | create a user |
GET | /v1/users | Get all users |
- Central error handler
- More tests and Type Checks
- Dockerize
- Deploy
- Akaniru Victory - Initial work - Vic3King