Users GraphQL

This is an API the uses both REST and GraphQL to store users in the database.
Explore the docs »

· Report Bug · Request Feature

📚 About The Project

I've been studying clean architecture these couple of weeks, so I'm trying to practice what I've learned so far, and this app summarizes some of the concepts I've been getting along with pretty well.

This project is a Users API, where you can store users in the database using both REST and GraphQL.

In this project, I used Apollo Server, which I quite enjoy, and express.

I'm practicing a lot of both unit and integration tests, as you can see in the coveralls badge, and it made me realize how important testing is when building new features, refactoring, and stuff like that.

🚀 Installation

1. Clone the repo

   git clone https://github.com/lucfersan/users-gql

2. Install NPM packages

   yarn

3. Create a database and a Postgres server using docker or your local machine.

🧪 Testing

You need to have a Postgres database running to test the Prisma integration.

💻 Running the app

# development
$ npm run dev

# production mode
$ npm start

🔺 Prisma Studio

$ npx prisma studio

🗞️ License

Distributed under the MIT License. See LICENSE for more information.

🤝 Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

📧 Contact

Lucas Fernandes - fernandes.lucas11@outlook.com