Git Product home page Git Product logo

childcare-mvp-saas's Introduction

Childcare SaaS Product

This is a Childcare SaaS Product, which aims to provide a platform for parents to find and hire caregivers for their children. The product allows caregivers to create a profile and list their availability, hourly rate, and location. Parents can search for caregivers based on their location, availability, and hourly rate, and can also view caregiver profiles to learn more about them.

Technologies Used

  • Node.js
  • Express.js
  • PostgreSQL
  • TypeScript
  • JWT for authentication
  • bcrypt for password hashing
  • dotenv for environment variables
  • express-validator for request validation

Getting Started

Prerequisites

  • Node.js installed on your machine
  • PostgreSQL installed on your machine

Installation

  1. Clone the repository:
git clone https://github.com/kirollosatef/childcare-mvp-saas
  1. Install dependencies:
cd childcare
npm install
  1. Create a .env file based on the .env.example file, and add the required environment variables.

  2. Create the PostgreSQL database and run the SQL script to create the necessary tables:

createdb childcare
psql childcare < database.sql

Usage

To start the server, run:

npm start

The server will start on http://localhost:3000.

Endpoints of User Registration

  1. Registration endpoint [PSOT]
  2. get user profile [GET]
  3. update user profile [PUT]
  4. login endpoint [POST]
  5. logout endpoint [POST]
  6. Delete user [DELETE]
    1. enable user [POST] or [PUT]
    2. disable user [POST]

URL Signature

  1. /api/users/register
  2. /api/users/profile
  3. /api/users/profile
  4. /api/login
  5. /api/logout
  6. /api/users
    1. /api/users/enable
    2. /api/users/disable

Project folder structure (per feature)

  • Caregiver
  • user-registration
    • register
      • register.controller.ts
      • register.service.ts
      • register.router.ts
    • profile
    • login-logout
  • DB
    • db.service.ts
  • server.ts

Notion DOCS if you need

Notion DOCS

childcare-mvp-saas's People

Contributors

kirollosatef 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.