Welcome to Soft Steps, your serene companion in achieving productivity effortlessly. This intuitive to-do app is designed to guide you through tasks with simplicity and elegance.
-
Clone the repository:
git clone <repository_url> cd server
-
Install dependencies:
npm install
-
Set up environment variables:
- Rename the
.env.example
file to.env
:mv .env.example .env
- Open the
.env
file and replace the placeholders with your Supabase credentials:SUPABASE_URL=https://<your_supabase_url>.supabase.co SUPABASE_KEY=<your_supabase_key> PORT=3000
- Rename the
-
Start the server:
npm run start:dev
This command compiles TypeScript, starts the server using Nodemon for development, and listens for file changes.
-
Navigate to the client directory:
cd client
-
Install dependencies:
npm install
-
Set up environment variables:
- Rename the
.env.example
file to.env
:mv .env.example .env
- Open the
.env
file and replace the placeholders with your environment variables:VITE_SUPABASE_URL=https://<your_supabase_url>.supabase.co VITE_SUPABASE_KEY=<your_supabase_key> VITE_API_BASE_URL=http://localhost:3000
- Rename the
-
Start the client:
npm run dev
This command launches the Vite development server.
-
Access the app:
- Open your browser and go to http://localhost:5173.
- Important: If you're using the local server, ensure the server is started before running the client. The client-side application relies on the server for API communication.
- Ensure no trailing slashes (
/
) are added to the.env
variable values. - The server defaults to port
3000
, but this can be adjusted in the.env
file. - Supabase credentials are required for authentication and database access.
Thank you for considering contributing to Soft Steps!
- Activate GitHub and Google authentication in your Supabase project before contributing.
- Fork the repository and clone it locally.
- Create a new branch for your feature or bug fix.
- Implement your changes, ensuring code quality and clarity.
- Commit your changes with meaningful commit messages.
- Push your branch to your forked repository.
- Submit a pull request to the
main
branch of the original repository.
This project is licensed under the MIT License.