Email is currently on pause, while I transition the project to a verified domain. If you would like to get into contact with me about the project or about a placement, you can email me directly at: ljsikuade@hotmail.co.uk.
Fledge is a tool for finding beginner-friendly repositories. Github is an intimidating place for newbies trying to contribute. It often isn't clear what tasks are beyond the scope of a beginner, or if someone starting out would actually make a useful contribution.
Fledge allows developers to flag their repositories as beginner friendly, by posting simple tasks in a .fledge.md file in their repo.
Fledge will automatically look for repositories that have this file type and list them.
To list your repository effectively, you will need to follow two simple steps:
- Create a .fledge.md file on the master branch (This is the default. Other branches must be configured in-app).
- Add a new topic to your repository: "fledge".
Note: The .fledge.md file must appear as is without prefixes. In the future this will be configurable in-app.
I experimented with a number of technologies that are new to me while building this.
- Github OAuth & Github GraphQL API
- Nodemailer
- Superagent
- Moment
- React-Scroll
To start getting to grips with the project's source code, some set up is needed.
-
Fork and clone this repository onto your machine.
-
A local installation of all dependencies for the project.
npm install
- Setting up the database (This is for extensibility's sake). I used MySQL for this project. Make sure you check which brand of SQL is appropriate for you. Database queries:
CREATE DATABASE fledge_data;
CREATE TABLE repos(repo_id VARCHAR(50) PRIMARY KEY);
CREATE TABLE xss_prevention(stringID INT AUTO_INCREMENT PRIMARY KEY, strings VARCHAR(50));
-
Setting up OAuth:
i) You will need to secure a client id and a client secret from Github's developer settings.
ii) You will need to create a .env file with the following parameters:
CLIENT_ID= <<YOUR ID HERE>>
CLIENT_SECRET=<<YOUR SECRET HERE>>
DB_HOST=<<YOUR DATABASE HOST HERE>>
DB_USERNAME=<<YOUR DATABASE USERNAME>>
DB_PASSWORD=<<YOUR DATABASE PASSWORD>>
DB_NAME=<<YOUR DATABASE NAME>>
GRAPHQL_AUTHENTICATION = <<YOUR GITHUB PERSONAL ACCESS TOKEN HERE>>