About this repository π
This repository talks about how to build an outstanding web server using latest Javascript technologies that can help micro entrepreneurs swiftly reach economic freedom.
Engine Requirement π
-- Node.js v16.x or v18.x
-- NPM v8+
Technology Stacks π
-- Node.js
-- Koa.js (Express.js Godfather) π₯π₯
-- Morgan (for logging purposes)
-- Mongodb πΎ
Project Structures π’
.
βββ README.md
βββ .env.example (this will be the environment file)
|ββ .gitignore
|ββ package.json
|ββ index.js (entry point)
βββ controllers/
| βββ ...[.js]
βββ helpers/
| βββ ...[.js]
βββ libraries/
| βββ ...[.js]
βββ middlewares/
| βββ ...[.js]
βββ repositories/
| βββ ...[.js]
βββ routes/
| βββ ...[.js]
βββ services/
| βββ ...[.js] (db connection or third party api)
Install Localy π§πΌβπ§
npm install
cp .env.example .env
)Running App π
npm start
Flow Development π
During the development cycle, a variety of supporting branches are used:
Creating a new feature
feature/name-of-feature
.npm run lint
to check standardize code or npm run lintfix
to auto fix non-standard code.Deployment π
This flow of deployment using Git Flow with 3 main branches