jamezjaz / e-comm_backend Goto Github PK

This is the backend of an e-commerce website. It's a GraphQL API designed with Apollo Server.
Explore the docs »

Report Bug · Request Feature

• About The Project
• End Point
• Built With
• Getting Started
• Author
• Contributing
• Acknowledgements
• License

This is the backend of an e-commerce website. It's a GraphQL API designed with Apollo Server. This is a third-party API provided by Scandiweb.

This API contains;

• Three different categories, viz: all, clothes, and tech categories.
• The index page (list of all products).
• The show page (which shows the details of a specific product).
• Each product has properties such as id, name, brand, an array of images, currency symbol, currency label, amount, attributes such as sizes, color, capacity depending on the product.

The server is deployed on Heroku here

The frontend is deployed on Vercel and Netlify

This project was built using these technologies.

• GraphQL
• Apollo Server
• TypeScript

To get a local copy up and running follow these simple example steps.

• Node.js is required to install dependencies and run scripts via npm.
• A modern browser

• Clone this repo:
  • Clone with SSH:

    [email protected]:jamezjaz/E-comm_Backend.git
  

  • Clone with HTTPS

    https://github.com/jamezjaz/E-comm_Backend.git
  

  • Clone with GitHub CLI

    gh repo clone jamezjaz/E-comm_Backend
    
  

• cd to E-comm_Backend

In order to start this endpoint, follow these steps

1. Install dependencies
2. Build the project - npm run build
3. Start the project - npm start

Contributions, issues and feature requests are welcome!

Feel free to check the issues page.

Give a ✯ if you like this project!

• I acknowledge Scandiweb for the opportunity to work with this API.

This project is MIT licensed.