Code Monkey home page Code Monkey logo

codewithkartikey / project-backend-store-your-task Goto Github PK

View Code? Open in Web Editor NEW
0.0 1.0 0.0 54 KB

This repository contains the backend for a task management application called Store Your Task. It provides RESTful APIs for user management and task management, allowing users to register, login, create tasks, update tasks, delete tasks, and many more.

JavaScript 100.00%
cors dotenv nodejs bcryptjs cookie-parser express jsonwebtoken mongoose morgan multer nodemailer zod

project-backend-store-your-task's Introduction

Project-Backend-Store-Your-Task

Description

This repository contains the backend for a task management application called Store Your Task. It provides RESTful APIs for user management and task management, allowing users to register, login, create tasks, update tasks, delete tasks, and many more.

Features

  • User Management
  • Task Management

Technologies Used

  • bcryptjs: For hashing passwords securely.
  • cookie-parser: For parsing cookies attached to the client requests.
  • cors: For handling Cross-Origin Resource Sharing.
  • dotenv: For loading environment variables from a .env file.
  • email-validator: For validating email addresses.
  • express: The web application framework for Node.js used for building APIs.
  • jsonwebtoken: For generating and verifying JSON Web Tokens for user authentication.
  • mongoose: For modeling application data and interacting with MongoDB.
  • morgan: For HTTP request logging during development.
  • multer: For handling multipart/form-data, primarily used for uploading files.
  • nodemailer: For sending emails for various things.
  • zod: For validating the data.

Installation

  1. Clone the repository:

    https://github.com/CodeWithKartikey/Project-Backend-Store-Your-Task.git
  2. Navigate to the project directory:

    cd Project-Backend-Store-Your-Task
  3. Install dependencies:

    npm install
  4. Set up environment variables:

    • Create a .env file in the project root directory.
    • Define the following variables in the .env file:
      • PORT: Port number for the server (default: 8080).
      • MONGODB_URI: MongoDB connection URI.
      • Other necessary variables for CORS configuration, SMTP settings etc.
  5. Start the server:

    npm start

Usage

  • Use a REST API client like Postman to interact with the server.
  • Refer to source code comments for details on available endpoints and their usage.

Contributing

We welcome contributions to improve this project! ๐Ÿ˜

Here's how you can contribute:

  1. Fork the repository: Click on the 'Fork' button on the top right corner of the repository's page. This will create a copy of the repository in your GitHub account.

  2. Create a new branch: Create a new branch in your forked repository to work on your feature or bug fix. You can do this using the following command:

    git checkout -b feature/my-feature

    Replace my-feature with a descriptive name for your feature or bug fix.

  3. Make your changes: Implement the changes or fixes in your branch.

  4. Commit your changes: Once you've made your changes, commit them with a descriptive commit message:

    git commit -am 'Add some feature'
  5. Push your changes: Push your changes to your forked repository:

    git push origin feature/my-feature
  6. Submit a pull request: Go to the main repository and click on the 'Pull Request' button. Provide a detailed description of your changes and submit the pull request. Your changes will be reviewed, and once approved, they will be merged into the main repository.

License

This project is licensed under the MIT License.

Credits


Designed, Developed & Maintained by CodeWithKartikey - Happy coding. ๐Ÿš€


project-backend-store-your-task's People

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.