Code Monkey home page Code Monkey logo

freshbey's Introduction

Freshbey

homepage-freshbey

An online grocery store | e-commerce

Project Purpose!

I am a huge enthusiast of open source. Contributing to open source is a fantastic way to learn and grow. Making open source contributions will require you to have been exposed to a few important concepts, practices, and transferable skills:

  • Version control
  • Working with tickets & issues
  • Working with other developers
  • Creating pull requests
  • Experiencing a code review process
  • Setting up a local development environment
  • Contributing code to a pre-existing codebase

General Idea

Freshbey is an e-commerce platform where users can order grocery items. I built this project originally for a client but they did not pay the agreed amount. After that, I made this project open source.

Current State

As of now, Freshbey is built using MERN stack. Additionally, React Bootstrap is used for styling and React Redux is used for state management.

Getting Started

Setting up the repository

Fork the repository at - roopeshsn/freshbey to your GitHub account.

Then clone the forked repository, by typing the following line in your local terminal/powershell. Remember to replace <your-username> with your actual GitHub username.

git clone https://github.com/<your-username>/freshbey.git

Navigate to the cloned repository on your local system

cd freshbey

Add remotes to the parent repository. This will help you fetch the code from the parent repo to avoid any merge conflicts later.

git remote add upstream https://github.com/roopeshsn/freshbey.git

To verify, use the command git remote -v to check if you have two remotes - origin and upstream set up.

Finally, fetch the upstream's latest code from the main branch.

git fetch upstream master

ES Modules in Node

We use ECMAScript Modules in the backend of this project. Be sure to have at least Node v14.6+ or you will need to add the "--experimental-modules" flag.

Also, when importing a file (not a package), be sure to add .js at the end or you will get a "module not found" error.

Env Variables

Create a .env file in then root and add the following

NODE_ENV = production
PORT = 5000
MONGODB_URI = mongodb+srv://admin:[email protected]/myFirstDatabase?retryWrites=true&w=majoritymyFirstDatabase?retryWrites=true&w=majority
JWT_SECRET = roopeshthemass123@
EMAIL_USERNAME = 2ebcd460696ef8
EMAIL_PASSWORD = cb7e54cd13fa8b
EMAIL_HOST = smtp.mailtrap.io
EMAIL_PORT = 2525

Install Dependencies (frontend & backend)

npm install
cd frontend
npm install

Run

# Run frontend (:3000) & backend (:5000)
npm run dev

# Run backend only
npm run server

Mail Service

Mailtrap (A Email Sandbox Service) is used as an email inbox to reset passwords.

Build & Deploy

The project is deployed on Heroku

git push heroku master

The above command is used to deploy the project on Heroku

Seed Database

You can use the following commands to seed the database with some sample users and products as well as destroy all data:

# Import data
npm run data:import

# Destroy data
npm run data:destroy

Contributing

Please check out CONTRIBUTING.md for more information regarding how to contribute.

Our Contributors ✨

License

MIT, see LICENSE

freshbey's People

Contributors

roopeshsn avatar felexonyango avatar dependabot[bot] avatar alpavlove avatar jjaijg avatar lucasfaustman avatar developedbysj avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.