Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sonusindhu/scp-portal-app
This repo is created to learn the reactjs for Frontend and sailsjs for backend. It is built with Reactjs, mui, ag-grid, sailsjs a nodejs framework. There are multiple module where user can authenticate and see the Companies, Contacts, Quotes, Inventories and we are planing to add WR Receipt, Package, Shipment.
https://github.com/sonusindhu/scp-portal-app
frontend javascript mui mysql mysql-server node node-js react react-router-dom-v6 react-sample-app reactjs sailsjs typescript
Last synced: about 2 months ago
JSON representation
This repo is created to learn the reactjs for Frontend and sailsjs for backend. It is built with Reactjs, mui, ag-grid, sailsjs a nodejs framework. There are multiple module where user can authenticate and see the Companies, Contacts, Quotes, Inventories and we are planing to add WR Receipt, Package, Shipment.
- Host: GitHub
- URL: https://github.com/sonusindhu/scp-portal-app
- Owner: sonusindhu
- Created: 2022-05-07T05:53:02.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2024-10-26T05:09:08.000Z (2 months ago)
- Last Synced: 2024-10-27T00:50:06.362Z (2 months ago)
- Topics: frontend, javascript, mui, mysql, mysql-server, node, node-js, react, react-router-dom-v6, react-sample-app, reactjs, sailsjs, typescript
- Language: TypeScript
- Homepage: https://scp-portal-app.onrender.com/
- Size: 1.5 MB
- Stars: 7
- Watchers: 3
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 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](#overview)
- [Directory Structure](#directory-structure)
- [Technologies Used](#technologies-used)
- [Getting Started](#getting-started)
- [API Documentation](#api-documentation)
- [Database Setup](#database-setup)
- [Contributing](#contributing)
- [License](#license)
## 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
```plaintext
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:
```bash
cd web-app
```
2. Install the dependencies:
```bash
npm install
```
3. Start the development server:
```bash
npm start
```
### Backend Setup
1. Navigate to the `web-api` directory:
```bash
cd web-api
```
2. Install the dependencies:
```bash
npm install
```
3. Complete [Database Setup](#database-setup):
4. Start the development server:
```bash
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`
```bash
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"`
```bash
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.