Skip to content

Latest commit

 

History

History
128 lines (92 loc) · 2.84 KB

README.md

File metadata and controls

128 lines (92 loc) · 2.84 KB

SCP Portal App

Welcome to the SCP Portal App! This project consists of two main components: a frontend web application and a backend API. Below is a brief overview of each component and how to set up the project.

Table of Contents

Overview

The SCP Portal App is designed to learn the basic concept of the React, salisjs(Nodejs). This application includes following modules and keep involving more...

  1. Companies
  2. Contacts
  3. Inventories
  4. Quotes
  5. User Profile

Directory Structure

scp-portal-app/
│
├── web-app/      # Frontend application
│
└── web-api/      # Backend API

Technologies Used

Frontend:

  • React
  • Material-UI (MUI)
  • AG Grid

Backend:

  • Sails.js (Node.js framework)

Database:

  • MySQL/MariaDB

Getting Started

To set up the project locally, follow these steps:

Prerequisites

  • Node.js (for both frontend and backend)
  • MySQL/MariaDB

Frontend Setup

  1. Navigate to the web-app directory:

    cd web-app

  2. Install the dependencies:

    npm install

  3. Start the development server:

    npm start

Backend Setup

  1. Navigate to the web-api directory:

    cd web-api

  2. Install the dependencies:

    npm install

  3. Complete Database Setup:

  4. Start the development server:

    sails lift

API Documentation

The API provides endpoints for various functionalities. Below are some key endpoints:

To review the APIs, go to routing settings in the backend configuration file. under web-api/config/routes.js

Database Setup

  1. Ensure that MySQL/MariaDB is installed and running.

  2. Create a new database for the project.

  3. Run the database migration scripts (if applicable) to set up the schema.

  4. Update the database connection settings in the backend configuration file. under web-api/config/datasources.js

    adapter: process.env.DB_ADAPTER || "sails-mysql",
url: process.env.DB_URL || "mysql://root@localhost:3306/sails_scpapi",

  5. Update the database model settings in the backend configuration file. under web-api/config/model.js, after the migration is done, just make it migrate: "safe"

    migrate: "alter"

Contributing

Contributions are welcome! Please follow these steps:

  1. Fork the repository.
  2. Create a new branch for your feature or bug fix.
  3. Commit your changes with a descriptive message.
  4. Push to the branch.
  5. Create a pull request.

License

This project is licensed under the Free License.