https://github.com/cr-israel/api-typescript-vitest

API made in TypeScript with Fastify and unit tests with Vitest
https://github.com/cr-israel/api-typescript-vitest

api-rest backend backend-api esbuild eslint eslintrc fastify github mongodb mongoose nodejs typescript unit-testing vitest vitest-ts

Last synced: 1 day ago
JSON representation

API made in TypeScript with Fastify and unit tests with Vitest

• Host: GitHub
• URL: https://github.com/cr-israel/api-typescript-vitest
• Owner: Cr-Israel
• Created: 2023-07-20T17:14:48.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2023-07-25T22:05:43.000Z (over 1 year ago)
• Last Synced: 2024-11-15T19:50:07.232Z (2 months ago)
• Topics: api-rest, backend, backend-api, esbuild, eslint, eslintrc, fastify, github, mongodb, mongoose, nodejs, typescript, unit-testing, vitest, vitest-ts
• Language: TypeScript
• Homepage:
• Size: 60.5 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        


  

  


  API-TypeScript-Vitest | Acessar



"API made in TypeScript with Fastify and unit tests with Vitest"




  

    

  

  



# What is it?

This is a RESTful API, developed in TypeScript with Fastify. I applied unit tests using Vitest, a powerful testing framework, and MongoDB.

Following REST standards, this API is fully flexible and easy to use.

It brings everything best, as Fastify's speed ensures quick and efficient responses.

# How to use?

1. Access https://github.com/Cr-Israel/api-typescript-vitest

2. Clone the project to your local machine:

  I. git clone

3. Start the project:

  I. npm start

  II. yarn start

4. Add your database credentials.



  
Variação 1

  

  
Variação 2

  


# How to install?

  Windows

  


  
To perform the installation via Windows:

   


      
Make sure you have Node installed on your machine

      
node --version

      
Clone this repository

      
Enter the repository

      
Run the command npm/yarn start

      
Project is running

   

  


 Unix

  


  
To perform the installation via Linux or MacOs:

   


      
Make sure you have Node installed on your machine

      
node --version

      
Clone this repository

      
Enter the repository

      
Run the command npm/yarn start

      
Project is running

   

  


# What's left to do?

- [x] Create entities

- [x] Apply unit tests

- [x] Database integration

  - [ ] Create a Front-End application

     - [ ] SPA integration

     - [ ] Deploy to production

# Credits

| Usuário                                   |     Contribution      |

|-------------------------------------------|-----------------------|

| [Cr-Israel](https://github.com/Cr-Israel) | Did the whole project |

# Contributions

Every Contribution is welcome, feel free to make a pull request!

# Feedbacks

All feedback is welcome, feel free to contribute and give your constructive criticism!

# Conclusion

This was the API-TypeScript-Vitest project.