-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
28 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1,28 @@ | ||
# GitToText-Backend | ||
# GitToText-Backend | ||
|
||
[![GitHub issues](https://img.shields.io/github/issues/bfuerholz/GitToText-Backend)](https://github.com/bfuerholz/GitToText-Backend/issues) | ||
[![GitHub forks](https://img.shields.io/github/forks/bfuerholz/GitToText-Backend)](https://github.com/bfuerholz/GitToText-Backend/network) | ||
[![GitHub stars](https://img.shields.io/github/stars/bfuerholz/GitToText-Backend)](https://github.com/bfuerholz/GitToText-Backend/stargazers) | ||
[![GitHub license](https://img.shields.io/github/license/bfuerholz/GitToText-Backend)](https://github.com/bfuerholz/GitToText-Backend/blob/main/LICENSE) | ||
|
||
GitToText-Backend is a Flask-based backend application for the GitToText project. It handles the processing of GitHub repositories and serves the frontend application. | ||
|
||
## Features | ||
|
||
- **Fetch Files**: Retrieve all files from a specified GitHub repository. | ||
- **Process Content**: Convert and clean the content for easy readability. | ||
- **API Endpoints**: Provide endpoints for the frontend to interact with. | ||
|
||
## How to Use | ||
|
||
The backend provides an API endpoint that the frontend interacts with to fetch and process repository data. | ||
|
||
## Deployment | ||
|
||
The backend is deployed on Vercel. Make sure to set up the necessary environment variables and configure the backend URL correctly in the frontend application. | ||
|
||
For detailed deployment steps, refer to the Vercel documentation. | ||
|
||
## License | ||
|
||
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details. |