https://github.com/jewel109/user-management

An API server for user management
https://github.com/jewel109/user-management

Last synced: 2 days ago
JSON representation

An API server for user management

• Host: GitHub
• URL: https://github.com/jewel109/user-management
• Owner: jewel109
• Created: 2024-11-29T05:11:35.000Z (2 months ago)
• Default Branch: master
• Last Pushed: 2024-12-05T13:46:43.000Z (about 2 months ago)
• Last Synced: 2024-12-06T13:34:20.339Z (about 2 months ago)
• Language: TypeScript
• Homepage:
• Size: 182 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
An API server having uniform success and failure structure as well as CI/CD practice .

# Installation

Node version `v22.4.1`

Clone this repo running

`git clone https://github.com/jewel109/user-management.git `

`cd` to `` dir and run `pnpm install`

# Run the project

Make an `.env` file and copy the content from `.env.example` file later give value in `PORT` in `.env`.

You are now `` dir.

Run the database by running `docker compose up --build`

Now run `pnpm run start:dev` to run the server.

You can see other available command in `package.json` file.

Your server is running now on the port *3232*.

Now run the tests by `pnpm test`

Now lint by `pnpm lint` and format by `pnpm format`

# End point

You can see the list of user by running `curl http://localhost:3232/user/users`

And you can add user to our server by running

```shell

curl -X POST http://localhost:3232/user/addUser \

-H "Content-Type: application/json" \

-d '{

  "name": "John Doe",

  "email": "[email protected]"

}'

```