svegalopez / hermit-server

Modern API server with support for REST and GQL

Hermit Server

                 

---

Hermit server is a stack that integrates various developer friendly technologies to create the ultimate dev experience.

Prisma

The schema located at src/hermit/prisma/schema.prisma will auto generate database migrations, a type-safe client, and typescript type definitions for you.

Apollo Server

Using apollo-express, Hermit exposes a graph at the path /graphql. Thanks to prisma and graphql-codegen, the resolvers located at src/hermit/services/apollo/resolvers.ts are fully typed.

Testing

When you run npm test, hermit uses ts-jest in order to run tests. A new environment is created behind the scenes for every spec file, so that each spec is ran in complete isolation. Jest calculates the code coverage and makes it available under test/coverage.

Ci-Cd

Using Github Actions and Heroku pipelines, the workflow is the following:

• Commit to your feature branch
• Open a PR from feature branch into main
• Automated tests will run in Github, and coverage 100% is enforced : )
• Once a PR is merged to main, the code will auto deploy to a staging environment
• Using the Heroku pipelines dashboard you can promote to production with a single click

Debug

To debug using vscode, simply place a breakpoint and then open package.json. Locate the script you would like to debug, click on Debug, and choose the appropriate script in the dropdown. You can debug both "start" and "test" programs.

hermit-server's Issues

Implement auth system using REST

see demo in guides.

• http endpoints (3)
• middleware
• one of the routes is protected with the middleware
• add extra layer of security by creating a UserLogin model and using cookies.

Create ci-cd pipeline

Update error messages and error handling in general

Create "createUser" route in rest

only admins are allowed to call this route

Create "getCurrentUser" route in rest

Create "createUser" route in gql

• Only admins are allowed to call this route
• Generate gql types
• Test
• Rename UserRoles to UserRole

Create missing edpoints

Create the endpoints necessary for user management:

• update a user and its roles

• list users and its roles

• create a role

• list roles

• add a role to a list of users

Create a JWT secret per environment

Protect the Query.users field

Currently, the query.users field is open to whoever is authenticated.
Make it so that only admins can access this field.

Errors in request handlers should not crash the server

Hermit 2.0 using di

Create "getCurrentUser" route in gql

• Include Roles in response
• Write tests
• Fix missing coverage for unrelated code

Create User REST endpoint