iStudyBucket

An awesome README template to jumpstart your projects!
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgements

About The Project

There are many great platforms for social interaction and communication in the world. None of which really targets the needs of student in this exponentially growing digital age.

Here's why:

• Your time online should be invested in interacting with individuals who can help with your study issues or hooks you can't seem to set loose in school.
• You shouldn't be stressing yourself with a problem when there is someone a few kilobytes of data access away from you who can solve it.
• You should have an excuse for while you are online while studying 😄

iStudyBucket comes as a solution to this issue and this project focuses on the services which will consume requests from our mobile and web applications.

A list of commonly used resources that we find helpful are listed in the acknowledgements.

Built With

• FreeMarker
• MySQL
• Spring
• Spring Boot
• Spring Data

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

Using IntelliJ IDEA Ultimate, STS, NetBeans or Eclipse

Install any of the mentioned IDEs on your computer which will come with the appropriate maven version.

• java
  • Download and install a stable version of JDK (pref 11) from the Oracle JavaSE Downloads page: JDK
  • Either set the JAVA_HOME environment variable pointing to your JDK installation or have the java executable on your PATH.

Otherwise: VSCode, Text Editor, Nano, Vim, whatever you prefer to suffer with

• maven
  • Download maven from: Maven
  • Install the downloaded maven on your computer by following this

Installation

1. Clone the repo

   git clone https://github.com/feljtech/istudybucket-backend.git

2. Open the cloned directory in your IDE (pref IntelliJ IDEA Ultimate)

Usage

We will use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. We may also link to more resources.

For more examples, please refer to the Documentation

Roadmap

See the open issues for a list of proposed features (and known issues).

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

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

Acknowledgements

• GitHub Pages
• Spring Boot