diff --git a/README.md b/README.md index bea5080..2e8d5fe 100644 --- a/README.md +++ b/README.md @@ -1 +1,47 @@ -# task_manager \ No newline at end of file +# SmartTask + +A task and project management application featuring a Node.js/Express/MongoDB backend and a Vanilla HTML/CSS/JS frontend. + +## Project Structure + +- `backend/`: Contains the Express server, MongoDB models, and API routes. +- `frontend/`: Contains the vanilla HTML, CSS, and JavaScript for the user interface. + +## Getting Started + +### Backend Setup + +1. Navigate to the backend directory: + ```bash + cd backend + ``` +2. Install dependencies: + ```bash + npm install + ``` +3. Set up environment variables: + Copy `.env.example` to a new file named `.env` and fill in your MongoDB connection string and JWT secret. + ```bash + cp .env.example .env + ``` +4. Start the development server: + ```bash + npm run dev + ``` + +### Frontend Setup + +The frontend is built with vanilla web technologies, so no build step is required. +You can serve the frontend files using a local development server (like VS Code's Live Server extension) or any static file server. + +1. Navigate to the frontend directory: + ```bash + cd frontend + ``` +2. Open `index.html` in your browser or start a local server to view the application. + +## Features + +- **User Authentication**: Secure signup and login using JWT. +- **Project Management**: Create and manage different projects. +- **Task Management**: Create, update, and organize tasks within projects.