Book marketplace

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Contributing
5. License
6. Contact

About The Project

This is a marketplace for books where users can sell and buy the books they want. Payment is made via the Stripe service, Authentication is done via the capabilities provided by authentication middleware Passport.JS. Platform data is stored in PostgreSQL, and user sessions are stored in Redis. Also, domain-driven design was chosen as an architectural approach to facilitate further scaling or transition to more modern tools, as well as to modalize the program to divide it into several desks, which would also simplify debugging or integration.

(back to top)

Built With

This section describes the services, technologies and frameworks I used in my project Here are a few examples.

Technologies:

Services:

Database schema:

(back to top)

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

• npm

  npm install

Installation

Below is an example of how you can instruct your audience on installing and setting up your app. This template doesn't rely on any external dependencies or services.

1. Get a API Key at Gmail, create your own API tokens in Stripe and SHIPPO
2. Clone the repo

   git clone https://github.com/hhuziuk/marketplace.git

3. Install NPM packages

   npm install

4. Enter your API data in .env

    PORT='ENTER_YOUR_API'
   
    GOOGLE_CLIENT_SECRET='ENTER_YOUR_API'
    GOOGLE_CLIENT_ID='ENTER_YOUR_API'
    GOOGLE_CLIENT_CALLBACK_URL='ENTER_YOUR_API'
    SESSION_SECRET='ENTER_YOUR_API'
    
    POSTGRES_HOST='ENTER_YOUR_API'
    POSTGRES_PORT='ENTER_YOUR_API'
    POSTGRES_USER='ENTER_YOUR_API'
    POSTGRES_PASSWORD='ENTER_YOUR_API'
    POSTGRES_DB='ENTER_YOUR_API'
    
    REDIS_PORT='ENTER_YOUR_API'
    REDIS_URL='ENTER_YOUR_API'
    REDIS_HOST='ENTER_YOUR_API'
    REDIS_SECRET='ENTER_YOUR_API'
    
    EMAIL_USER='ENTER_YOUR_API'
    EMAIL_PASS='ENTER_YOUR_API'
    EMAIL_PORT='ENTER_YOUR_API'
    EMAIL_HOST='ENTER_YOUR_API'
    
    SHIPPO_API_KEY='ENTER_YOUR_API'
    
    STRIPE_PUBLISHABLE_KEY='ENTER_YOUR_API'
    STRIPE_SECRET_KEY='ENTER_YOUR_API'
    
    API_URL='ENTER_YOUR_API'

(back to top)

Usage

To get better acquainted with the usage, I recommend you to read the documentation written with Swagger

Or if you want to make some tests, i recommend you to import MarketplaceOuter.postman_collection.json to Postman.

(back to top)

Contributing

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

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

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

(back to top)

License

Distributed under the GPL-3.0 License. See LICENSE.txt for more information.

(back to top)

Contact

Heorhii Huziuk - [email protected]

Project link: https://github.com/hhuziuk/marketplace.git

(back to top)