Skip to content

A web app around bring accessibility to GitHub repositories

License

Notifications You must be signed in to change notification settings

adamsulemanji/GitFriendly

Repository files navigation

This is a Next.js project bootstrapped with create-next-app.

Getting Started

First, run the download the project and run the following command to install the dependencies and prepare the project:

npm run prepare

To run just the frontend, run the following command:

npm run dev

Open http://localhost:3000 with your browser to see the result.

To run the backend, run the following command:

npm run flask

Open http://127.0.0.1:5000 with your browser to see the result.

To run both the frontend and backend, run the following command:

npm run slay

Open 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 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:

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:

You can check out the Next.js GitHub repository - 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 from the creators of Next.js.

Check out our Next.js deployment documentation for more details.

About

A web app around bring accessibility to GitHub repositories

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 3

  •  
  •  
  •