https://github.com/afk247/invoice-dashboard-server
https://github.com/afk247/invoice-dashboard-server
Last synced: 11 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/afk247/invoice-dashboard-server
- Owner: AFK247
- Created: 2025-04-10T11:59:48.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-04-11T14:45:41.000Z (about 1 year ago)
- Last Synced: 2025-04-12T11:50:30.266Z (about 1 year ago)
- Language: TypeScript
- Homepage: https://invoice-dashboard-server.vercel.app
- Size: 47.9 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Node JS Project Setup
This guide will help you get started with running this Node js project locally.
## Installation
1. Clone the repository:
```bash
git clone https://github.com/AFK247/invoice-dashboard-server
cd invoice-dashboard-server
```
2. Install dependencies:
```bash
npm install
# or
yarn install
```
## Environment Variables
Create a `.env` file in the root directory and add your environment variables:
```plaintext
PORT=5000
DB_HOST=localhost
DB_USER=root
DB_PASSWORD=your_db_password
DB_NAME=your_db_name
DB_PORT=3306
```
## Database Setup
After setting up the environment variables, execute the MySQL schema to initialize the database table for operation. Use the provided `invoice.sql` file in this repository.
## Running the Project
### Development Mode
To run the project in development mode with hot-reload:
```bash
npm start
```
The application will be available at `http://localhost:5000`
### Production Build
To create a production build:
```bash
npm run build:prod
```
To start the production server:
```bash
npm run start
# or
yarn start
```