This document outlines the functional and non-functional requirements for the Book Website, a platform for consumers to explore, purchase, and review books, and for administrators to manage the platform. The system encompasses book categorization, user management, cart management, order processing, and content management. Read More
first please ensure to checkout develop branch
git clone https://github.com/nahidnstu12/bookmark-backend
for install dependencies, run
yarn
copy env.example to env.development and set your environment varianbles
copy env.test.example to env.test and set your environment varianbles
create your database for dev & test
then you ready to run your project dev mode, run
yarn start:dev
when you want to seeding, run
yarn db:seed
and when you want to run tests, run
yarn test
If you want to visit swagger docs, visit
http:localhost:6050/api/v1/docs
if you want to single file test, run
yarn run test auth.test.js --watchAll=false
- Express TS
- TypeORM (mysql)
- SwaggerUI for docs
Documentaion: Docs Link UML diagram : bookmark uml diagram
- Mazharul Islam Nahid
- Sajeda Akter Saju