CircleCI Coverage Status Reviewed by Hound

TypeScript Next.js Storybook CircleCI ESLint Prettier Jest Tailwind CSS CodeClimate Redux

alpha-ec-fe

Alpha E-Com

merce --- Frontend

Different Badges will go here.

Usage description

  • This App will used for E-commerce.
  • All users will be able to chat publicly in the app
  • Sellers will be able to list their products and their respective prices
  • Users/Buyers will be able to buy products and provide ratings
  • Among other usefull features

Technologies used

The project uses:

Backend

Node Express : the core back end technology
Render: Used to host our app online PostgreSQL Is used as our database management tool
Swagger Used for API documentation.

Frontend

Figma : Used to prototype the User interface
TailwindCSS: Front end framework for styling Next js: Front end framework
Redux: a predictable state container for JavaScript apps.

Online app

The link to the live deployment frontend

REST API Docs

You can visit the api documentation here

Installation and usage instructions

  • Clone the repository using: git clone https://github.com/atlp-rwanda/alpha-ec-fe.git
  • Add environment variables if needed
  • Run npm install To install the project dependencies
  • Run npm run dev To start the application locally
  • Open http://localhost:3000