Skip to content

Rak-Code/TaskManagementApp

Folders and files

NameName
Last commit message
Last commit date

Latest commit

History

3 Commits

Repository files navigation

Certainly! Here's a template for a README file that covers the key aspects of your project. You can customize it further as needed:


Task Management App

Overview

This is a task management application built with a React frontend and a Node.js backend, using MySQL for data storage. Users can create, update, and delete tasks, with data stored and managed in a MySQL database. The project includes user-specific data segregation and has been styled with Tailwind CSS.

Features

  • Task Management: Create, update, and delete tasks.
  • User Authentication: Manage user-specific data.
  • Responsive Design: Styled with Tailwind CSS.
  • Backend Integration: API endpoints for CRUD operations.

Technologies

  • Frontend: React.js, Tailwind CSS
  • Backend: Node.js, Express.js
  • Database: MySQL
  • Deployment: Vercel (Frontend), Heroku (Backend)

Setup

Prerequisites

  • Node.js and npm installed
  • MySQL database

Backend Setup

  1. Clone the Repository:

    git clone https://github.com/your-username/your-repository.git cd your-repository/backend
  2. Install Dependencies:

    npm install
  3. Configure Environment Variables:

    Create a .env file in the backend directory and add your environment variables:

    DB_HOST=localhost DB_USER=root DB_PASS=your-database-password DB_NAME=TASKDB JWT_SECRET=your-jwt-secret 
  4. Run the Backend Server:

    npm start

Frontend Setup

  1. Navigate to the Frontend Directory:

    cd your-repository/frontend
  2. Install Dependencies:

    npm install
  3. Build the React App:

    npm run build
  4. Run the Development Server:

    npm start

Deployment

Deploying the Backend

  1. Prepare Your Backend for Deployment:

    Ensure your backend is production-ready and has the necessary environment variables configured.

  2. Deploy to Heroku:

    • Install the Heroku CLI and log in:

      npm install -g heroku heroku login
    • Create a Heroku app:

      heroku create
    • Deploy your code:

      git add . git commit -m "Deploying backend" git push heroku main
    • Set up environment variables:

      heroku config:set DB_HOST=your-database-host DB_USER=your-database-user DB_PASS=your-database-password DB_NAME=TASKDB JWT_SECRET=your-jwt-secret

Deploying the Frontend

  1. Choose a Hosting Platform:

    Examples include Vercel, Netlify, or GitHub Pages.

  2. Deploy the Build Directory:

    Upload the contents of the build directory to your chosen hosting service.

Usage

  1. Frontend:

    Access the app via the URL provided by your hosting service.

  2. Backend:

    Ensure your frontend application is configured to use the production backend URL.

Contributing

  1. Fork the repository.
  2. Create a new branch (git checkout -b feature/your-feature).
  3. Commit your changes (git commit -am 'Add new feature').
  4. Push to the branch (git push origin feature/your-feature).
  5. Create a new Pull Request.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Acknowledgements

  • Tailwind CSS for styling.
  • React and Node.js for the development framework.
  • MySQL for data storage.

Feel free to modify this README to better fit the specifics of your project and personal preferences.

Releases

No releases published

Packages

No packages published