Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/lucasbbs/proshop

Last synced: about 2 months ago
JSON representation

Host: GitHub
URL: https://github.com/lucasbbs/proshop
Owner: lucasbbs
Created: 2021-03-28T02:19:22.000Z (almost 4 years ago)
Default Branch: master
Last Pushed: 2024-05-15T15:22:47.000Z (8 months ago)
Last Synced: 2024-05-16T04:29:28.841Z (8 months ago)
Language: JavaScript
Size: 1.04 MB
Stars: 0
Watchers: 2
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

# Proshop

## Project Overview

This project is an e-commerce application built using the MERN stack (MongoDB, Express.js, React, Node.js). It features a fully functional shopping cart, user authentication, and a product management system.

## Prerequisites

Ensure you have the following installed on your system:

- Node.js
- npm (Node Package Manager)
- MongoDB (you can use a cloud instance from MongoDB Atlas)

## Installation Guide

### 1. Clone the Repository

```bash
git clone https://github.com/lucasbbs/proshop.git
cd proshop
```
### 2. Install Dependencies

Navigate to the project directory and install the dependencies for both the backend and frontend:

#### For backend

```bash
npm install
```
#### For frontend

```bash
# For frontend
cd ../frontend
npm install
```

### 3. Setup Environment Variables

1. Obtain a MongoDB connection string from MongoDB Atlas or a local installation from MongoDB.
2. Paste the connection string into the .env.example file under the MONGO_URI key.
3. Rename the .env.example file to .env.

```bash
MONGO_URI=your_mongodb_connection_string
```

### 4. Run the Application

Navigate to the root directory of the project and start the application:

```bash
npm start
```
The project is configured to use nodemon, so both the frontend and backend will run concurrently.

## Features

- User Authentication (Login/Register)
- Product Management (CRUD operations for products)
- Shopping Cart
- Order Management

## Technologies Used

- MongoDB: Database for storing user and product data
- Express.js: Backend framework for handling API requests
- React: Frontend library for building user interfaces
- Node.js: JavaScript runtime for the backend

## Contributing

If you wish to contribute to the project, please follow these steps:

Fork the repository.
Create a new branch (git checkout -b feature-branch).
Make your changes and commit them (git commit -m 'Add new feature').
Push to the branch (git push origin feature-branch).
Open a pull request.

## :closed_book: License

This project is licensed under the MIT License. See the LICENSE file for more details.
Released in 2021 :closed_book: License

Made with :heart: by [Lucas Breno de Souza Noronha Braga](https://github.com/lucasbbs) 🚀.
This project is under the [MIT license](https://github.com/lucasbbs/iMonitor-Backend/master/LICENSE).

## Contact

For any inquiries or issues, please contact:

[![Static Badge](https://img.shields.io/badge/WhatsApp-25D366?style=for-the-badge&logo=whatsapp&logoColor=white)](https://api.whatsapp.com/send?phone=12267247739)
[![Static Badge](https://img.shields.io/badge/Microsoft_Outlook-0078D4?style=for-the-badge&logo=microsoft-outlook&logoColor=white)](mailto:[email protected])
[![Static Badge](https://img.shields.io/badge/GitHub-100000?style=for-the-badge&logo=github&logoColor=white)](https://github.com/lucasbbs/)
[![Static Badge](https://img.shields.io/badge/LinkedIn-0077B5?style=for-the-badge&logo=linkedin&logoColor=white)](https://linkedin.com/in/lucasbbs/)