C4B - Restful API

About   |   Features   |   Technologies   |   Requirements   |   Starting   |   License   |   Authors

🎯 About

This project served as a base for a Bank Loan Request App in which an API could be able to receive Loan Requests, send emails to customers and bank account owners, and finally generate contracts between the Bank and the customer.

We released it for people who wants a boilerplate for a similar Restful API project using .NET framework.

✨ Features

✔️ Fully Restfull API
✔️ Email Service
✔️ Pdf Contract Service
✔️ E2E Tests for sites that uses this API
✔️ Swagger support

🚀 Technologies

The following tools were used in this project:

• C#
• .NET
• SQLite
• Playwright

✅ Requirements

Ubuntu was used to implement the project, so the .net SDK is required to be installed first. See Microsoft docs in this link

🏁 Starting

# Clone this project
$ git clone https://github.com/42voyager/c4b-backend

# Access
$ cd backend

# Run API Server
dotnet run --project api/backend.csproj

# The Swagger server will initialize in http://localhost:5000/swagger/index.html

👀 Swagger

The app on development will enable the Swagger Service. It can be accessed by running http://localhost:5000/swagger/index.html on the local development machine.

🚨 Issues

Feel free to submit issues and enhancement requests.

🌒 Contributing

Please refer to each project's style and contribution guidelines for submitting patches and additions. In general, we follow the "fork-and-pull" Git workflow.

1. Fork the repo on GitHub
2. Clone the project to your own machine
3. Commit changes to your own branch
4. Push your work back up to your fork
5. Submit a Pull request so that we can review your changes

NOTE: Be sure to merge the latest from "upstream" before making a pull request!

📝 License

This project is under license from MIT. For more details, see the LICENSE file.

Made with ❤️ by Paco Rocha Diego Cisneros Marcus Vinicius

 

Back to top