Skip to content

Latest commit

 

History

History
108 lines (71 loc) · 5.44 KB

README.md

File metadata and controls

108 lines (71 loc) · 5.44 KB
Raw

iStudyBucket API

This is the backend of the iStudyBucket project, built with Spring and contains the application business logic. iStudyBucket is an application which gives students the chance to share and learn together on content regarding school as they would on social media. The aim of this is to have a platform (similar to StackOverflow, Reddit, Facebook) where students (targetting Cameroon, and Africa later) can post, comment and review content from others strictly for learning purposes and education.

This backend is built with Java and targets Java 11. We use Maven to manage dependencies, Freemarker for html templates, and JUnit for testing.

Table of Contents

Make sure this is updated based on the sections included:

Documentation

NO DOCUMENTATION AVAILABLE FOR THIS PROJECT YET

Installation

To get this project running on your personal computer or server, ensure you have:
To run this project, follow these steps
  • Clone this repository on your machine using this command:
git clone https://github.com/istudybucket/istudybucket-backend
  • Navigate to the application directory
mvn spring-boot:run -Dspring-boot.run.arguments=--server.port=8000

If you are using a modern IDE like Eclipse STS, NetBeans or IntelliJ (Ultimate / Community + Plugins), then your IDE may pick up the configurations from analysing the project in its workspace, and set up all necessary prerequisites for you.

Getting Started

Once you have successfully had the application running on your machine, you can carry on from here. Ensure you have an HTTP Client (preferably Postman) on your machine to communicate with the API.

You however do not need a specific HTTP Client as we have SwaggerUI in this application which can show you all the API endpoints and offers a simple interface for communicating with the application.

  • To view and communicate with all endpoints using swagger on your local machine, visit http://localhost:8080/swagger-ui/
  • Using SwaggerUI Client or your favorite HTTP Client, try out the application by making a simple request to this endpoint: {sample endpoint}
  • Explore more by trying out these various endpoints: {various endpoints}

Contributing

We appreciate feedback and contribution to this repo! Before you get started, please see the following:

Support + Feedback

Include information on how to get support. Consider adding:

  • Use Issues for code-level support
  • Use Community for usage, questions, specific cases

Thank You!

{List out dependencies here}

License

Link to LICENSE doc. Typically MIT but can be different for a specific platform.