Skip to content

Latest commit

 

History

History
73 lines (44 loc) · 2.63 KB

README.md

File metadata and controls

73 lines (44 loc) · 2.63 KB
Raw

DesignPlannerLogo

Design Planner

Design Planner is a web application built to assist developers plan the database modeling. It provides a platform for creating and managing database models and collaborating with team members. If it is SQL or NO SQL database you can design and plan.

Features

  • User Authentication: Secure user authentication system using JWT tokens.
  • Project Creation: Users can create new projects and set project details such as name, and description
  • Database Model Creation: Organize Models and connect with lines for relations.
  • Dashboard: Overview of all projects and database models.
  • Search and Filter: Easily find projects.
  • Responsive Design: Compatible with various devices and screen sizes.

Future Feature

  • Collaboration: Invite team members to collaborate on projects, and build database models together.

Tech Stack

  • Frontend: Built with React.js for a dynamic and interactive user interface.
  • Backend: Developed using Node.js and Express.js for handling server-side logic and API endpoints.
  • Database: MongoDB used as the database for storing project, task, user, and authentication data.
  • Authentication: JWT tokens for secure user authentication and authorization.
  • Deployment: Not yet decided.

Getting Started

Prerequisites

  • Node.js and npm installed on your machine.
  • MongoDB installed locally or access to a MongoDB instance (can also use a cloud-based MongoDB service).

Installation

  1. Clone the repository:

    • git clone

  2. Navigate to the project directory:

    • cd design-planner

  3. Install dependencies:

    • npm install

  4. Set up environment variables:

    • Create a .env file in the root directory.
    • Define environment variables such as PORT, MONGODB_URI, and JWT_SECRET.

  5. Start the development server:

    • npm start

  6. Open your browser and navigate to http://localhost:5173 to access the application.

Contributing

Contributions are welcome! Please feel free to submit pull requests or open issues for any improvements or bug fixes.

License

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

Acknowledgements

  • This project was inspired by the need for a comprehensive tool for designers to plan and manage their projects effectively.
  • Special thanks to the MERN stack community for their invaluable resources and support.