Initial commit: Add documentation and gitignore
🤖 Generated with Claude Code Co-Authored-By: Claude <noreply@anthropic.com>
This commit is contained in:
53
RUNNING_INSTRUCTIONS.md
Normal file
53
RUNNING_INSTRUCTIONS.md
Normal file
@@ -0,0 +1,53 @@
|
||||
# Smart Calendar Project - Running Instructions
|
||||
|
||||
This document provides instructions on how to run the Smart Calendar Project (Reclaim.ai clone) in WSL.
|
||||
|
||||
## Prerequisites Installed
|
||||
|
||||
The following prerequisites have been installed in your WSL environment:
|
||||
- Node.js and npm
|
||||
- PostgreSQL database
|
||||
- Database schema has been applied to the `reclaim_clone` database
|
||||
- Client dependencies have been installed
|
||||
|
||||
## Running the Application
|
||||
|
||||
### 1. Start PostgreSQL (if not already running):
|
||||
```bash
|
||||
sudo service postgresql start
|
||||
```
|
||||
|
||||
### 2. Start the frontend development server:
|
||||
```bash
|
||||
cd ~/reclaim-clone/client
|
||||
npm run dev
|
||||
```
|
||||
|
||||
The frontend will be available at http://localhost:3000
|
||||
|
||||
### 3. (Optional) Start the backend server:
|
||||
Note: The Swift backend requires Swift to be installed in WSL, which is a more involved process. The backend would typically run on port 8080.
|
||||
|
||||
## Current Status
|
||||
|
||||
Currently, the frontend is fully set up and ready to run. The database is configured and ready for use.
|
||||
|
||||
To run the complete application with backend functionality, Swift would need to be installed in WSL, which requires additional steps specific to your Ubuntu version.
|
||||
|
||||
## Quick Start Script
|
||||
|
||||
You can use the provided script to quickly start the frontend:
|
||||
```bash
|
||||
~/start_project.sh
|
||||
```
|
||||
|
||||
Then access the application at http://localhost:3000
|
||||
|
||||
## Stopping the Application
|
||||
|
||||
To stop the application:
|
||||
1. Press Ctrl+C in the terminal where the development server is running
|
||||
2. If you started PostgreSQL, you can stop it with:
|
||||
```bash
|
||||
sudo service postgresql stop
|
||||
```
|
||||
Reference in New Issue
Block a user