Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/krislette/pupstols
An RDBMS web app for the stall owners of Polytechnic University of the Philippines built on ReactJS, NodeJS, and Bootstrap.
https://github.com/krislette/pupstols
database mariadb nodejs reactjs
Last synced: 4 months ago
JSON representation
An RDBMS web app for the stall owners of Polytechnic University of the Philippines built on ReactJS, NodeJS, and Bootstrap.
- Host: GitHub
- URL: https://github.com/krislette/pupstols
- Owner: krislette
- License: mit
- Created: 2024-06-20T09:39:52.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2024-07-09T14:06:11.000Z (7 months ago)
- Last Synced: 2024-09-28T11:04:02.879Z (4 months ago)
- Topics: database, mariadb, nodejs, reactjs
- Language: JavaScript
- Homepage:
- Size: 10.7 MB
- Stars: 0
- Watchers: 1
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## About The Project
> This project aims to connect MariaDB with Node.js
> to build a web application for PUP stall owners.
> MariaDB will manage data storage, while Node.js will handle
> the server-side operations.
### Table Of Contents
-
About The Project
-
Database Design
-
Website Snapshots
-
Folder Structure
-
Getting Started
-
Run
-
Contributors
-
License
### Features
- Authentication System
- Log in and log out function
- Dashboard
- PUP Lagoon Carousel
- Profile
- Sign Up
- Inventory Management
- Finance Management
- Transaction Management
- Rent History Tracking
### Technologies Used
PUPStols uses a number of open source projects to work properly:
- [React](https://react.dev/): A JavaScript library for building user interfaces, maintained by Facebook.
- [Node.js](https://nodejs.org/en): A JavaScript runtime built on Chrome's V8 JavaScript engine, used for server-side scripting.
- [Express](https://expressjs.com/): A fast, unopinionated, minimalist web framework for Node.js.
- [MariaDB](https://mariadb.org/): An open-source relational database management system, compatible with MySQL.
- [bcrypt](https://www.npmjs.com/package/bcrypt): A library to help hash passwords.
- [jsonwebtoken](https://www.npmjs.com/package/jsonwebtoken): An implementation of JSON Web Tokens (JWT) for authentication.
## Database Design
Database design plays a very important part in the Software Development Life Cycle (SDLC). This part includes creating metadata, normalization, and constructing an Entity-Relationship Diagram (ERD).
- [PUPStols Metadata](https://drive.google.com/file/d/1UBAPrvSfFIW2WUNqS5b-kiP3ZzwysLKH/view?usp=sharing)
- [PUPStols Normalization](https://docs.google.com/spreadsheets/d/1WO5OKFjlz0yTrVRhVDeLzsTTGsUBFzDk/edit?usp=drive_link&ouid=110674875045139190778&rtpof=true&sd=true)
- [PUPStols ERD](https://drive.google.com/file/d/1bBlRUzZ9ulnMjQjbUQo2Ej92lAeqAjNu/view?usp=drive_link)
To add, provided [here](https://drive.google.com/file/d/1P2I2Az3IUgq-aQCmdNX28bRDJkf_ARUN/view?usp=drive_link) is the `.sql` file of `dbStalls` (the database used) if you want to have the database ready with dummy data.
## Website Snapshots
### Log in page
### Sign up page
### Home page
### CRUD page example
### Read-only page
### Profile page
## Folder Structure
.
├── client # Client-side folder
│ ├──── node_modules # React Packages
│ ├──── public # Auto-generated react files
│ └──── src # Source files
├── server # Server-side folder
│ ├──── config # Database connection
│ ├──── controllers # Controllers
│ ├──── middlewares # Middlewares
│ ├──── models # Models
│ ├──── node_modules # Node Packages
│ ├──── routers # Endpoints
| └──── server.js # Main server file
└── README.md
## Getting Started
PUPStols is not yet accessible to the world wide web, as it is yet to be deployed. But, if you're interested in seeing the UI and experience the website yourself, you are in the right section of the README. To get started with accessing the source code, follow the steps below.
### Prequisites
- Ensure that Node.js and npm are installed on your machine.
### Installation
1. You can fork this repository, or you can also clone this repository directly on your local machine.
2. After cloning the repository on your local machine, access it on any IDE.
> After opening the project, you should see all the files listed on
> the [Folder Structure](#Folder-Structure), but without the `.env` for the server-side code.
3. Install dependencies using,
```bash
npm install
```
3. Create a .env on the server folder and type the code below. Make sure to replace `YOUR_DB_PASSWORD_HERE` with your actual **MariaDB/MySQL/Any RDBMS password**.
```bash
DATABASE_PASSWORD="YOUR_DB_PASSWORD_HERE"
```
3. Configure the database connection in `server/config/db.js` as per your MariaDB/MySQL/Any RDBMS database environment.
4. To install the required dependencies for the **client** folder, see the [`package.json`](https://github.com/krislette/pup-stalls/blob/main/client/package.json) for the client-side.
5. To install the required dependencies for the **server** folder, see the [`package.json`](https://github.com/krislette/pup-stalls/blob/main/server/package.json) for the server-side.
## Run
- Run the server on `/server`.
```bash
node server.js
```
- With `nodemon`, you can run the server using,
```bash
npm run server
```
- Run the client on `/client`.
```bash
npm start
```
## Contributors
**We would like to thank the following contributors for their support and contributions to this project:**
Acelle
Coded the backend (server) and the frontend (client) using NodeJS, ReactJS, and ExpressJS. Created the database and tables using `cmd`. Created the carousel feature and the whole website.
Leo
Added visual flairs on the frontend by refining the initial look of the website.
## License
Distributed under the [MIT](https://choosealicense.com/licenses/mit/) License. See [LICENSE](LICENSE) for more information.
