Backend-Blog-Application

Best Practices, not just code

Comment

Why i made blog application?

I believe if something works is just half work done*. Code can be messy or not good readable or not good format or don't have used better approach or have used tools which ain't work in production. my blog application is simple as you have used but with the fact it has used several best practices which stand out. My primary goal for this hackathon was to document the project better.

What it does

It has several endpoints frontend application can use:

- GET    /articles             Get all published articles
- GET    /articles/drafts Get all draft articles
- GET    /articles/:id       Get article by Id
- POST   /articles            Create article                 @Body: CreateArticleDto
- PATCH  /articles/:id    Update article by Id       @Body: UpdateArticleDto
- DELETE /articles/:id    Delete article by Id

How i built it

  • Build using NestJS, Swagger, Prisma ORM ( PostgreSQL), docker

Challenges i ran into

  • I was working solo so only myself wanted to motivate and push to work.

Accomplishments

  • Beginner friendly docs

What i learned

  • Learn about working with docker, Using Swagger (OpenAPI specfication) with NestJS, Spin up my very own first postgreSQL instance.

What's next for Backend-Blog-Application

  • Due to time frame and this was my very first proper hackthon i couldn't add lot of feature
  • also my primary goal for this was to use best practices that did took my time
  • my application at current stage doesn't support user validation
  • Each user could have several articles need to add that
  • I could have write test and have CI/CD pipelines with github actions.
  • deploy this project for making it publicly.
  • last but not least i could have made the postman collection too so people who don't like to request from swagger can use it.

Built With

Share this project:

Updates