Sickfits v2

An awesome ecommerce platform build with the latest tech!
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

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

About The Project

This is a Ecommerce project created for learning purposes. This project is based on a course, however some different technologies are applied. This is a continous WIP (Work in Progress).

(back to top)

Built With

• Next.js
• React.js
• Emotion
• Keystone
• PostgreSQL
• Turborepo
• React-Query

(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

1. Get a free API Key at https://example.com
2. Clone the repo

   git clone https://github.com/guimochila/sickfits-v2.git

3. Install NPM packages

   yarn

4. Go to apps/backend and rename the file .env.sample to .env

   mv .env.sample .env

5. Fill out the information inside the .env file:

   DATABASE_URL=postgres://localhost:5432/sickfits
   FRONTEND_URL=http://localhost:3000/
   COOKIE_SECRET=secret
   PORT=4000
   CLOUDINARY_CLOUD_NAME=
   CLOUDINARY_KEY=
   CLOUDINARY_SECRET=
   MAIL_HOST=
   MAIL_PORT=
   MAIL_USER=
   MAIL_PASS=
   STRIPE_SECRET=

6. In the root folder of the project run yarn run dev:

   yarn run dev

7. Access in your browser:

• Frontend

  http://localhost:3000

• Backend

  http://localhost:4000

(back to top)

Roadmap

• Add Changelog
• Add turborepo
• Deployment
• Update Components Structure
• Improve UI
• Add more tests

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

Your Name - @guimochila - [email protected]

Project Link: https://github.com/guimochila/sickfits-v2

(back to top)