Ur-Codebin [REST API]

An easy to use REST API backend for the Ur-Codebin website
View The Website »

Explore the docs · Report Bug · Request Feature

Table of Contents

• About the Project
  • Technologies Used
• Usage
• Getting Started
  • Prerequisites
  • Installation
  • Contributing
• License
• Contact

About The Project

Ur-Codebin is a website aimed at creating an easy to use code sharing platform, that allows users to quickly and efficiently share their code with others. This project is inspired by many other similar websites.

This repository is specifically the backend api for the website. It can be used to handle most requests relating to the website functionality. This API is secured by JWT token authentication except for all public endpoints. To get authenticated, a user must authenticate themselves using the /account/login endpoint. More information about authentication and other endpoints can be found in the Api Documentation.

Technologies Used

• Spring Boot - Used as the main framework and foundation for the entire web application.
• Maven - A very important dependency and library management system.
• MySQL - This was the database used for the development and production environments.
• Docker - Docker was used to containerize the project to easily deploy on the server.
• AWS EC2 - The dockerized application is deployed on an EC2 instance.
• Nginx - Used as a reverse proxy to route "/api" calls to this REST API service.
• CloudFlare - Mainly used for free SSL certification and caching.

Usage

You can use this REST API to make calls to add/delete/get any information regarding the Ur-Codebin application, and the pastes that have been uploaded. Authentication is mandatory for any non-public endpoints. Authentication is done through a login endpoint and returns a Bearer JWT Token as an authentication header. More information regarding the endpoints can be found in the Api Documentation.

To learn more about the database schema and how the application stores related information. Head to the following Database Schema link and look through the relationships among all the tables.

Getting Started

The following are steps for users who wish to get a local copy of the web application running on their machine, and contribute to the project.

Prerequisites

The following needs to be installed on your machine for the application to properly work.

• Maven
  • Download Tutorial
• MySQL On Local Machine

Cloning

1. Go to your preferred directory

cd FakeFolder/NotRealDirectory/

2. Clone the repo

git clone https://github.com/Mathew-Estafanous/Ur-Codebin-API.git

3. Run app using maven

mvn spring-boot:run

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

License

This project is protected under the MIT License! See LICENSE or https://en.wikipedia.org/wiki/MIT_License for more detailed information regarding permissions and protections regarding this open-source project.

Contact

If you have any questions or comments regarding this project. Feel free to reach out through my email.

Mathew Estafanous - [email protected]

Project Link - https://github.com/Mathew-Estafanous/Ur-Codebin