/Ademotor-cars

Ademotor is simply an ecommerce website

Primary LanguageJavaScript


AdeMotor

Ademotor Ecommerce website
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact
  8. Acknowledgments

About The Project

Desktop Mode

This project is an ecommerce website. which describes the services Ademotor car selling company and their locations.

Mobile screen

(back to top)

Built With

Here are the list of major frameworks/ libraries used to bootstrap this project

(back to top)

Features

This is a a list of unique features this project comprise of;

  • Simple design ecommerce website
  • Very easy to use web application
  • The web application sends order mails on successful order of a product
  • The web application is responsive
  • The web application is equipped with fast and reliable database

Order Email

Sample Email

Database storage

Sample Database

Elegant design

Mobile

Sign and Registration

Mobile

(back to top)

Getting Started

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 npm@latest -g

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. Clone the repo

    git clone https://github.com/BigYusuf/Ademotor-cars.git

  2. Install NPM packages backend

    npm install

  3. Install NPM packages frontend

    cd API
cd frontend
npm install

  4. Enter your KEYS in .env

    MONGO_URL = "ENTER YOUR MONGODB URI";
PORT = "ENTER YOUR PORT NUMBER";
JWT_SECRET = "ENTER YOUR JWT SECRET";
JWT_EXPIRES_TIME = "ENTER YOUR JWT EXPIRY TIME";
PAYPAL_CLIENT_ID="ENTER YOUR PAYPAL CLIENT ID";
PAYPAL_SECRET="ENTER YOUR PAYPAL SECRET"
USER_EMAIL="ENTER ORDER ADMIN EMAIL FOR SECURE GMAIL NODEMAILER SETUP"
CLIENT_ID="ENTER CLIENT ID FOR SECURE GMAIL NODEMAILER SETUP"
CLIENT_SECRET="ENTER CLIENT SECRET FOR SECURE GMAIL NODEMAILER SETUP"
REDIRECT_URI= "ENTER YOUR REDIRECT URI FOR SECURE GMAIL NODEMAILER SETUP"
REFRESH_TOKEN= "ENTER REFRESH TOKEN FOR SECURE GMAIL NODEMAILER SETUP"

  5. Search for axiosinstance., then remove the // from //import Axios from 'axios'; then add // to import {axiosInstance} from '../config.js';. Most of files containing the searched key word can be found in the actions folder

    //import Axios from 'axios';
import {axiosInstance} from '../config.js';

Mobile

(back to top)

Usage

Here are some useful Account to consider while testing the web application For Admin priviledges:

  email: `admin@example.com`
  password: `123456`

For other users: you can just sign in with a fake email and choose any password of your chosen. just for testing, you just use the following accounts

  email: `yusuf@example.com`
  password: `123456`

For more examples, please refer to the Documentation

(back to top)

Roadmap

  • Design Web application
    • Create React App
    • Create all components and pages
    • Create css for the enrichment of the application
    • Create dummydata for testing of web application
  • Create Backend
  • Link to MongoDB
  • Create constants, actions, reducers
  • Add Send Email functionality
  • Add Codes to github
  • Add / update Project Readme file
  • Host website on heroku
  • Filter and sort products design
  • Create well detail report on Project (Documentation)
  • Test functionality of website and its limits
  • Host website on custom domain
  • Continuous update and linking to blog post

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

(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/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

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Yusuf Lateef - Connect via Messenger - yusuflateef0000@gmail.com mystik5551@gmail.com

Project Link: https://github.com/BigYusuf/Ademotor-cars

(back to top)

Acknowledgments

Here are the list of resources I find helpful and would like to give credit to.

(back to top)