Skip to content
@starter-kits-usmb

starter-kits-usmb

Starter kits USMB

This organization is a collection of starter kits made by USMB students.

📚 Starter kits ready

A starter kit is ready when it has a all the requirements listed here. All starter can be used with any other starter kit of this organization. (e.g one front-xxx with one back-xxx)

Name Description
front-angular A starter kit for angular projects
back-nestjs A starter kit for nest js projects
front-vue3 A starter kit for vue3 projects

📝 Starter kits in progress

State Name Description
WIP back-java-spring-boot A starter kit for java projects with spring boot

🤝 Contributing

If you want to contribute to this organization, you can ask to a new starter kit by creating an issue with the starter-kit label here.

You can also contribute to an existing starter kit by creating a pull request on the starter kit repository.

Minimal requirements for a starter kit

Frontend

  • A README.md file with a description of the project and how to run it
  • Scalable folder structure
  • Linter and prettier
  • Routing
  • Authentification service with JWT
  • Light design system and layout utilities see files
  • Toast service (snackbar and loading screen)
  • Modal service (support custom modals)
  • Test setup
  • docker compose file for development & production

Backend

  • A README.md file with a description of the project and how to run it
  • Scalable folder structure
  • Linter and prettier
  • Authentification with JWT.
  • Auth guard for routes (protected routes)
  • Database setup (any)
  • Swagger documentation available at /api
  • Test setup
  • docker compose file for development & production

Authentification

Authentification should have at least 3 endpoints:

POST /auth/login

Login user with credentials and return a JWT token.

body
{
  "login": "string",
  "password": "string"
}
response
{
  "token": "string"
}

POST /auth/register

Register a new user. Return the user id and login.

body
{
  "login": "string",
  "password": "string"
}
response
{
  "id": "number",
  "login": "string"
}

GET /auth

Verify the token. Return 202 response if the token is valid and 401 if not.

headers

Authorization: token

Pinned Loading

  1. front-angular front-angular Public template

    starter kit with angular

    HTML 4

  2. back-nestjs back-nestjs Public template

    TypeScript

Repositories

Showing 5 of 5 repositories
  • front-angular Public template

    starter kit with angular

    starter-kits-usmb/front-angular’s past year of commit activity
    HTML 4 0 0 0 Updated Aug 4, 2024
  • back-java-spring-boot Public template

    starter kit with spring boot

    starter-kits-usmb/back-java-spring-boot’s past year of commit activity
    Java 1 1 0 0 Updated Dec 15, 2023
  • back-nestjs Public template
    starter-kits-usmb/back-nestjs’s past year of commit activity
    TypeScript 0 0 0 0 Updated Dec 11, 2023
  • front-vue3 Public template
    starter-kits-usmb/front-vue3’s past year of commit activity
    Vue 0 0 0 0 Updated Nov 30, 2023
  • .github Public
    starter-kits-usmb/.github’s past year of commit activity
    SCSS 0 0 0 0 Updated Nov 29, 2023

People

This organization has no public members. You must be a member to see who’s a part of this organization.

Top languages

Loading…

Most used topics

Loading…