Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
mohit-nagaraj committed Dec 20, 2024
1 parent 044e088 commit 1b5afc9
Showing 1 changed file with 49 additions and 12 deletions.
61 changes: 49 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,24 +2,61 @@

This project is designed to help you manage your expenses efficiently using GraphQL.

- 🌟 Tech stack: MERN (MongoDB, Express.js, React.js, Node.js) + Apollo GraphQL
- 🚀Authentication with Passport.js and MongoDB session store
This project uses a package.json file at root and the commands here help u start the backend server from a frontend dist folder. If you want to run everything locally, see the setup-local section below.

## Tech Stack
- 🌟 MERN (MongoDB, Express.js, React.js, Node.js)
- 🚀 Apollo GraphQL
- 🔒 Authentication with Passport.js and MongoDB session store
- 👾 Cron jobs for scheduled tasks and automation
### Setup .env file

## Features
- User authentication and session management
- Expense tracking and management
- GraphQL API for efficient data querying
- Scheduled tasks using cron jobs

## Setup

### Prerequisites
- Node.js
- npm (Node Package Manager)
- MongoDB

### .env File Configuration
Create a `.env` file in the root directory and add the following environment variables:

```js
MONGO_URI=mongodb+srv://<dish>:<dish>123@...
SESSION_SECRET=<putur->secret123>
MONGO_URI=mongodb+srv:<username>:<password>@<cluster-url>/<dbname>?retryWrites=true&w=majority
SESSION_SECRET=<your-session-secret>
PORT=4000
```
### Build the app

```shell
### Build the App
To build the app, run the following command:
```bash
npm run build
```
### Start the app

```shell
### Start the Server
To start the server, run the following command:
```bash
npm start
```
```
### Usage
Once the app is running, you can access it in your web browser at http://localhost:3000. You can register a new account, log in, and start managing your expenses.
## Setup Locally
If you want to run everything locally, you can follow these steps:
```bash
cd frontend
npm install
npm run dev
cd ..
npm install
npm run dev
```
Do change the server url to local host when running the server locally.
## Contributing
Contributions are welcome! Please fork the repository and create a pull request with your changes. Make sure to follow the code style and include tests for any new features or bug fixes.

0 comments on commit 1b5afc9

Please sign in to comment.