Sickfits v2
An awesome ecommerce platform build with the latest tech!
Explore the docs »
View Demo
·
Report Bug
·
Request Feature
Table of Contents
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).
Built With
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
- Get a free API Key at https://example.com
- Clone the repo
git clone https://github.com/guimochila/sickfits-v2.git
- Install NPM packages
yarn
- Go to apps/backend and rename the file
.env.sample
to.env
mv .env.sample .env
- 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=
- In the root folder of the project run
yarn run dev
:yarn run dev
- Access in your browser:
- Frontend
http://localhost:3000
- Backend
http://localhost:4000
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).
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!
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature
) - Commit your Changes (
git commit -m 'Add some AmazingFeature'
) - Push to the Branch (
git push origin feature/AmazingFeature
) - Open a Pull Request
License
Distributed under the MIT License. See LICENSE.txt
for more information.
Contact
Your Name - @guimochila - [email protected]
Project Link: https://github.com/guimochila/sickfits-v2