https://github.com/adamsulemanji/gitfriendly
A web app around bring accessibility to GitHub repositories
https://github.com/adamsulemanji/gitfriendly
accessibility github repositories
Last synced: about 2 months ago
JSON representation
A web app around bring accessibility to GitHub repositories
- Host: GitHub
- URL: https://github.com/adamsulemanji/gitfriendly
- Owner: adamsulemanji
- License: mit
- Created: 2024-04-17T02:06:42.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-05-14T16:08:18.000Z (about 2 years ago)
- Last Synced: 2025-09-23T17:43:45.747Z (9 months ago)
- Topics: accessibility, github, repositories
- Language: Python
- Homepage:
- Size: 13.6 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
This is a [Next.js](https://nextjs.org/) project bootstrapped with [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app).
## Getting Started
First, run the download the project and run the following command to install the dependencies and prepare the project:
```bash
npm run prepare
```
To run just the frontend, run the following command:
```bash
npm run dev
```
Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
To run the backend, run the following command:
```bash
npm run flask
```
Open [http://127.0.0.1:5000](http://127.0.0.1:5000) with your browser to see the result.
To run both the frontend and backend, run the following command:
```bash
npm run slay
```
Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file.
This project uses [`next/font`](https://nextjs.org/docs/basic-features/font-optimization) to automatically optimize and load Inter, a custom Google Font.
## Project Structure
The project contains a frontend and a backend. The frontend is a Next.js project and the backend is a Flask project.
# Accessory commmands
The project contains some accessory commands to help with the development of the project. The commands are as follows:
```bash
npm run clean
```
This command will lint and prettier the project to ensure that the code is clean and well formatted.
## Learn More
To learn more about Next.js, take a look at the following resources:
- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.
- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.
You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome!
## Deploy on Vercel
Currently the project is not ready to be deployed on Vercel. The backend is not yet ready to be deployed.
The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js.
Check out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details.