AlexandruRoman / little-store-backend

Little Store

An e-commerce web app based on react

Report Bug · Request Feature

Table of Contents

• About the Project
  • Built With
• Getting Started
  • Prerequisites
  • Installation
• Usage
• Roadmap
• Contributing
• License

About The Project

Today, the vast majority of e-commerce frameworks are using PHP as their main programming language. And that's a little bit ironical when you think that the language of the web is not the language of e-commerce.

That's how this project began: as a React alternative to the PHP world of e-commerce.

Built With

• Node.js
• Express.js
• TypeScript
• Mongo DB
• Mongoose

Getting Started

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

Prerequisites

• Install Node.js

Installation

1. Clone the repo

git clone https://github.com/AlexandruRoman/little-store-backend.git

2. Install NPM packages

npm install

3. Enter your Mongo connection string in src/mongo.ts

const url = 'YOUR CONNECTION STRING'

Usage

An example of getting the details of a product using curl:

curl -X GET http://localhost/product/get/3

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the MIT License.