Marketplace-Frontend - Technical documentation

Overview

Marketplace Application - Functional Documentation

Production Link

Visit the production version here: Marketplace

Description

This is the frontend for a marketplace, implemented using React. This frontend connects with a backend REST API to manage operations related to sellers and other marketplace resources.

Prerequisites

Before getting started, make sure you have Node.js and npm installed on your system. This project was created with create-react-app.

Installation

To install and set up the project locally, follow these steps:

1. Clone the repository:

   git clone https://github.com/salvadormartin3z/Marketplace-Frontend
   cd Marketplace-Frontend
   

2. Install the dependencies:

   npm install

3. Set up environment variables: Create a .env file in the root of the project with the following variables necessary for the backend connection and other important configurations.

   REACT_APP_API_URL=http://localhost:8000

   Note: The .env file is not included in the repository for security reasons. You must create your own .env file locally.

4. Start the server:

   npm start

   This will compile the application and open a window in your default browser. If the browser does not open automatically, you can manually access http://localhost:3000.

5. You will also need to install and set up the project's backend for full functionality:

• Backend: Backend en GitHub

Contact

You can find and contact me through the following platforms:

• Portafolio: Salvador Martínez - Portafolio
• LinkedIn: Salvador Martínez en LinkedIn
• GitHub: Salvador Martínez en GitHub

Contributing

If you want to contribute to the project, consider forking the repository and submitting your pull requests. You can also open issues if you find any problems or have suggestions for improvements.

License

This project is licensed under the MIT License. See the LICENSE file in this repository for more details.