Store Discount

Live Demo · Report Bug · Request Feature

📔 Table of Contents

• About the Project
  • Screenshots
  • Tech Stack
  • Environment Variables
• Getting Started
  • Prerequisites
  • Run Locally With NPM
• Contributing
• Contact
• Acknowledgements

🌟 About the Project

📷 Screenshots

Live Demo: https://store-discount.vercel.app/

👾 Tech Stack

BackEnd:

FrontEnd:

Cloud:

Tools:

🔑 Credential File

To run this project, you will need the following credential file:

• Firebase Admin SDK
  Go to firebase console -> pick your project -> project setting -> service account tab -> genereate new private key
• Firebase Config/Client
  Go to firebase console -> pick your project -> project setting -> in general tab scroll down -> click add app button -> pick web logo "<\>" -> fill app nickname & click register app -> copy all const firebaseConfig variabel value -> make a new json file -> paste value from firebaseConfig variabel before and save the json file

Note: Note: if you are someone i know, request & download my credential Here

🧰 Getting Started

‼️ Prerequisites

• Install node.js version 18.16.0 here
  Make sure your node.js and npm already install in your device using, open cmd and run:

  node -v
  npm -v

  Note: In development i using Windows 10 Pro, Visual Studio Code, node version 18.16.0, and npm version 9.5.1.
• Credential File
• Docker (optional)

🏃 Run Locally With NPM

Follow this step to run this repostory code in your local device:

1. Open git bash and Clone the repo

git clone https://github.com/Muhthoriqas/Store-DiscountStore-Discount.git

2. Go to project folder

cd Store-Discount

3. Open the project at VS Code

code . 

4. open terminal, go to backend directory, & install package

cd backend && npm install

5. Make sure you already have the Credential File and store the credential file name in app/config/config.sample.json file.
6. And also Change projectID, bucketName, and databaseURL value at app/config/config.sample.json file, with your GCP project id, bucket name, and firestore database url
7. Change config.sample.json file name to config.json
8. Start the server

   npm start, or
   npm run dev (using nodemon)

9. open new terminal and go to front end directory

cd frontend && npm install 

10. Start the frontend server

npm run dev 

Note:

1. Steps 5-7 are only performed if you do not have access to My Credential. If you are someone i know, please request to obtain my credentials and config file. After you download my credential make sure to store it at app/config folder.

👋 Contributing

Contributtor in this repostory:

Contributions are always welcome! All types of contributions are encouraged and valued. It will make it a lot easier for us maintainers and smooth out the experience for all involved. The community looks forward to your contributions. 🎉

And if you like the project, but just don't have time to contribute, that's fine. There are other easy ways to support the project and show your appreciation, which i would also be very happy about:

• Star the project
• Tweet about it
• Refer this project in your project's readme
• Mention the project at local meetups and tell your friends/colleagues

🤝 Contact

Muhammad Thoriq Ali Said - LinkedIn - Github - Instagram

💎 Acknowledgements

Bellow is useful resource that i used in my project

• Next.js Docs
• Express.js Docs
• Clour Run Deploy With Artifact Registery
• Cloud Run CI/CD Tutorial
• Readme Template