Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/douglasdotv/code-sharing-platform
A simple web application built with Spring Boot, Spring Data and Thymeleaf.
https://github.com/douglasdotv/code-sharing-platform
code-sharing-platform hyperskill java spring-boot spring-data spring-mvc thymeleaf
Last synced: 23 days ago
JSON representation
A simple web application built with Spring Boot, Spring Data and Thymeleaf.
- Host: GitHub
- URL: https://github.com/douglasdotv/code-sharing-platform
- Owner: douglasdotv
- Created: 2023-03-05T17:06:43.000Z (almost 2 years ago)
- Default Branch: master
- Last Pushed: 2023-04-10T17:53:45.000Z (almost 2 years ago)
- Last Synced: 2024-11-14T05:35:16.152Z (3 months ago)
- Topics: code-sharing-platform, hyperskill, java, spring-boot, spring-data, spring-mvc, thymeleaf
- Language: Java
- Homepage:
- Size: 35.4 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
## code-sharing-platform
[](https://github.com/douglasdotv/code-sharing-platform/blob/master/README.md)
[](https://github.com/douglasdotv/code-sharing-platform/blob/master/README.pt-br.md)
### About
This is a web application that allows users to share code snippets with each other.
**Example 1:**
**Example 2:**
The user can write code, set an expiration date and/or a maximum number of views for it, and then share the code snippet link with others.
Both time and views restrictions are optional.
If they are set, the snippet will be private and available until a restriction is reached (it is deleted from the database after that).
On the other hand, if none of them are set, the snippet will be public and available forever.
(Negative or null values and the number 0 for the `time` and `views` fields are interpreted as an absence of a restriction. Positive values are interpreted as a restriction.)
Available endpoints:
* `GET /code/new` - Create a new code snippet page
* `POST /api/code/new` - Save a new code snippet
* `GET /code/{id}` - Access a code snippet page
* `GET /api/code/{id}` - Get a code snippet in JSON format
* `GET /code/latest` - Access the latest public code snippets (code snippets without time or views restriction)
* `GET /api/code/latest` - Get the latest public code snippets (code snippets without time or views restriction) in JSON format
### Project stages
Stages
### Technologies used
* Java 17
* Gradle
* Spring Boot 2.5.6
* Spring MVC
* Spring Data JPA
* H2 Database
* Thymeleaf
* highlight.js
* Bootstrap
### Skills developed throughout the project
* How to use Spring Boot and Spring MVC to create a web application
* How to use Spring Data JPA and H2 to work with a database
* How to use Thymeleaf to create a web page
* How to use highlight.js to highlight code snippets
* How to use Bootstrap to style a web page
### How to run the project
1. Make sure that you have JDK (Java Development Kit) and JRE (Java Runtime Environment) installed on your computer and that you're connected to the Internet.
2. Open a terminal and clone the repository:
```
git clone https://github.com/douglasdotv/code-sharing-platform.git
```
3. Navigate to the project folder:
```
cd code-sharing-platform
```
4. Build and run the application
```
./gradlew build
./gradlew bootRun
```
5. Access the application endpoints using a browser or a client like Postman or Insomnia.
(The application will run on port 8889 by default.)
(Example: http://localhost:8889/code/new)
### Contact
If you have any questions or suggestions, feel free to contact me via [LinkedIn](https://www.linkedin.com/in/douglasdotv/) or via email ([email protected]).