calvietech / sneakery__client

Sneakery: A MERN sneaker app

View Demo · Report Bug · Request Feature

Table of Contents

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

About The Project

My motivation is to create a MERN web app where users can share and post images of sneakers I built this project because I love sneakers, especially Nike and Air Jordans. I learned alot from this project. I learned how to use JSON Web Tokens (JWT), ensure authorized users are able to access the proper routes, and deploy the app on the Web.

(back to top)

Built With

• 
• 
• 
• 
• 

(back to top)

Getting Started

To get a local copy up and running on your machine, follow these simple steps!

Prerequisites

You will need the following list of things to use the software:

• npm

  npm install npm@latest -g

Installation

1. Clone the repo (SSH)

   git clone [email protected]:calvieTech/sneakery.git

2. Go to the project root directory

   cd sneakery

3. Install NPM packages

   npm install

4. Type the following in your terminal

   npm run build:dev

5. Serve the app

   npm run serve:dev

(back to top)

Usage

Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.

Demo

register1

login1

loginAndCreate

create1

delete1

update1

(back to top)

Roadmap

• Create a front-end UI in React
• Create a back-end API using Node and Express
  • Create the controllers for users
  • Create the controllers for sneakers
• Create MongoDB schemas
  • Create schema for users
  • Create schema for sneakers
• Wire the front-end to the back-end
  • Front-end should be hitting backend API endpoints
• Wire the back-end to the MongoDB
  • MongoDB API key is not visible
  • Back-end should connect to MongoDB Atlas using API key
• [] Finish front-end production build

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/newFeature)
3. Commit your Changes (git commit -m 'Add some Cool new feature!')
4. Push to the Branch (git push origin feature/newFeature)
5. Open a Pull Request

(back to top)

License

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

(back to top)

Contact

Calvin Thang @ [email protected]

Project Link: https://github.com/calvieTech/sneakery

(back to top)

Acknowledgments

• Calvin Thang
• Ye Paing

(back to top)