Skip to content
Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 35 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,41 @@

---

## 🧑‍💻 Local Development

To work on the application locally:

1. Clone the repository and change into the app folder:
```bash
git clone https://github.com/KGFCH2/Gsecure.git
cd Gsecure/gsecure
```
2. Install dependencies:
```bash
npm install
```
3. Copy the example environment file and configure your local values:
```bash
cp .env.local.example .env.local
```
4. Update `.env.local` with the actual values for:
- `MONGODB_URI`
- `NEXT_PUBLIC_API_HOST`
- `ACCESS_TOKEN_SECRET`
- `ACCESS_TOKEN_EXPIRY`
- SMTP and email settings if you need password reset email support

5. Start the development server:
```bash
npm run dev
```

6. Open `http://localhost:3000` in your browser.

> Note: the frontend and API are served together from the `gsecure/` folder using Next.js.

---

## 🛠️ Tools and Utilities

- **Password Generator**
Expand Down