Skip to content

Pkomia/NearMartX

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

4 Commits
 
 
 
 
 
 

Repository files navigation

NearMartX

NearMartX is a full-stack project designed to provide a seamless shopping experience. It consists of a frontend built with React and a backend powered by Node.js.

Project Structure

NearMartX/
├── nearmartx-frontend/   # Frontend (React)
├── nearmartx-backend/    # Backend (Node.js)
└── README.md             # Project documentation

NearMartX Frontend

The frontend is built using React and provides a user-friendly interface for customers to browse and shop.

Features

  • Responsive design
  • Product listing and search
  • Shopping cart functionality
  • User authentication
  • Order history

Prerequisites

Installation

  1. Navigate to the frontend directory:

    cd nearmartx-frontend
  2. Install dependencies:

    npm install

    or

    yarn install
  3. Start the development server:

    npm start

    or

    yarn start

The frontend will run on http://localhost:3000 by default.


NearMartX Backend

The backend is built using Node.js and provides APIs for managing users, products, orders, and more.

Features

  • User authentication and authorization
  • Product management
  • Order processing
  • API documentation
  • Error handling and logging

Prerequisites

Installation

  1. Navigate to the backend directory:

    cd nearmartx-backend
  2. Install dependencies:

    npm install

    or

    yarn install
  3. Create a .env file in the root directory and configure the required environment variables. Refer to .env.example for guidance.

  4. Start the development server:

    npm run dev

    or

    yarn dev

The backend will run on http://localhost:5000 by default.


Scripts

Frontend

  • npm start - Start the development server
  • npm run build - Build the project for production

Backend

  • npm start - Start the production server
  • npm run dev - Start the development server
  • npm run build - Build the project
  • npm test - Run tests

Contributing

Contributions are welcome! Please follow these steps:

  1. Fork the repository.
  2. Create a new branch: git checkout -b feature-name.
  3. Commit your changes: git commit -m 'Add some feature'.
  4. Push to the branch: git push origin feature-name.
  5. Open a pull request.

License

This project is licensed under the MIT License. See the LICENSE file for details.


Contact

For any inquiries or support, please contact:

About

Very awesome portfolio for beginner

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors