This is the Baquet and Catering System for Deandra, developed using React.js for the frontend and Express.js for the backend.
To set up and run this project locally, follow these steps:
Clone this repository to your local machine:
git clone https://github.com/pathuGIT/OrionX.git
cd OrionX-
Navigate to the backend directory:
cd backend -
Install the backend dependencies:
npm install
-
Create the
.envfile in thebackenddirectory and configure necessary environment variables for your application. Example:PORT=8000 -
Create a
.gitignorefile in thebackenddirectory to ignore sensitive files and dependencies:node_modules/ .env
-
Navigate to the frontend directory:
cd ../frontend -
Install the frontend dependencies:
npm install
-
Create the
.envfile in thefrontenddirectory and add the environment-specific variables. Example:REACT_APP_API_URL=http://localhost:5000 -
Create a
.gitignorefile in thefrontenddirectory to ignore unnecessary files:node_modules/ .env
To run both the backend and frontend:
-
Start the Backend:
Navigate to the backend folder and run:
npm start
The backend server will be running at
http://localhost:5000(or your configured port). -
Start the Frontend:
Navigate to the frontend folder and run:
npm start
The frontend will be available at
http://localhost:3000by default.
Ensure you have the required tools installed for both the frontend and backend:
- Node.js: Version 14 or later is recommended.
- mysql (for the backend): Make sure Mysql is running locally.
/OrionX
|-- /backend
| |-- /controllers
| |-- /models
| |-- /routes
| |-- .env
| |-- .gitignore
| |-- server.js
|
|-- /frontend
| |-- /src
| |-- .env
| |-- .gitignore
| |-- package.json
|
|-- README.md
Now you're all set up to start working on OrionX! You can modify, extend, or deploy the application as needed. If you run into any issues, feel free to open an issue in the repository.