kauefraga / crud-rest

🔮 A restful CRUD to put some effort

CRUDzão com Restful

🍃 Building an API Restful to use all good practices that i've known and keep learning 🍃

⬇️ How to download

git clone https://github.com/kauefraga/crud-rest.git
cd crud-rest
pnpm i
pnpm dev

# If you want to run tests
pnpm test

Or downloading with yarn? yarn && yarn dev
If you still prefer npm: npm i && npm run dev

✨ Features

• Linters: Eslint (config-airbnb-typescript)
• Huge tests coverage
• Code good practices
  • Repositories pattern
  • Implementation first and feature with dependencies after

💻 Technologies

• 🎟️ Generating unique identifiers with CUID
• 💄 Code ruling with Eslint
  • https://www.npmjs.com/package/eslint-config-airbnb-base
  • https://www.npmjs.com/package/eslint-config-airbnb-typescript
• ⚗️ Running tests on Vitest

  Implements Jest but with its own ESbuider (out of box typescript, esmodules...)

• 🧑‍💻 Developed on Typescript + TS-Node-Dev

  Improve dev experience by adding type safety

🗃️ Routes view (not implemented)

# Return a specific user -> user (!name = all users)
GET /users/{name} ou /users?name=...

# Return a specific user post -> post (!id = all user posts)
GET /users/name/posts/{id}

# Create a user -> user
POST /users/create

# Create a post -> post
POST /users/name/posts/create

# Update a post -> post (if i can, a diff)
PUT /users/name/posts/id

# Delete a user -> user/void
DELETE /users/name

# Delete a post -> post/void
DELETE /users/name/posts/id

📝 License

This project is licensed under the MIT License - See the LICENSE for more information.

---