vikings-ec-bn

E-commerce API

This is a backend API built using Express.js framework for an e-commerce website. The API provides several features including:

• Product Catalog
• Shopping Cart
• Payment Gateway
• Order Management
• User Profile
• Search and Filtering
• Reviews and Ratings
• Wish List

INSTALLATION

Requirements

For development, you need to have node installed and npm package installed in your environment.

Node

Node installation on windows

Just go to the Nodejs website and download the installer. in addition, make sure you have git available in your path. npm migth need it. Find it here

Node installation on Linux and other operating system

Refer to the documentation and offical npm website npm website

NPM installation

npm install npm

Project Installaton

clone the project, by running the commands below in your terminal.

git clone https://github.com/atlp-rwanda/vikings-ec-bn.git

cd vikings-ec-bn

package installation

npm install

Running the app

Before running the project locally, make sure you have all required environment variables in your .env file. you can find the required environment variables in .env.example file.

Database migration and seeding

Run migrations

npm run migrate

Run seed

npm run seed

development mode

npm run dev

testing mode

npm run test

Reset database

npm  reset:db

Documentation

Swagger documentation endpoint for your the backend project

Replace {port} with your port on which development server is running ex:http://localhost:5000/api-docs

http://localhost:{port}/api-docs

Docker-compose

Docker installation

download docker Destop here or use docker toolbox CLI here

run docker-compose

docker-compose up -d

Deployment

• Vikings E-commerce API

Contributors

• TUYIZERE Fidela
• IRAKOZE Yves
• NDATUMUREMYI Paterne
• MUNEZERO Olivier Hugue
• MUKUNZI Fabrice
• BRUNE Abdul Ghafar
• NSHIMIYIMANA Jean Damascene
• UKUNDIWABO UWERA Aline