README.md

Git Connected

Git Connected is a social networking application that allows software engineers to reciprocate connections, follows, and endorsements - built by and for the 100Devs community.

Table of Contents

• Features
• Tools and technologies
• Contributing ♥️
• Installation and local development
• Contributors
• License

Features

• Login through Discord OAuth first checks if a user is a part of the 100Devs server
• Connect your GitHub and Twitter accounts
• Update your username, location, and bio
• Follow other 100Devs directly in-app
• A featured 100Dev page

Made by and for the 100Devs community

User login that only allows members of the 100Devs Discord server.

Connect across Twitter, GitHub, and Discord

Follow other 100Devs and be followed on all platforms, directly in-app.

Future improvements:

• Users can add tags to their profiles (coffee chat, currently employed, looking for work, group project, etc.)
• User search by location and tags
• Group project forum where users can pin GitHub repos

Tools and technologies

Frontend

• TypeScript
• React
• Axios
• Tailwind CSS
• Styled-components
• Twin.macro

Backend

• TypeScript
• Node
• Express
• MongoDB
• Passport
  • Discord OAuth 2.0
  • GitHub OAuth 2.0
  • Twitter OAuth 1.0a

Contributing

Please see the CONTRIBUTING.md for a detailed guide on contributing.

This project follows the all-contributors specification. Contributions of any kind are welcome!

There are several ways to help.

1. Spread the word: More users means more people testing and contributing to the app which in turn means better stability and possibly more and better features. You can tweet about it, share it on LinkedIn, reddit or any of your favorite social media platforms. Every little bit helps!

2. Provide a Pull Request: Here is a list of the most popular community requests and here's some info on installation and setup. Please make sure that you're following the Conentional Commits guideline and to also include the issue number in your commit message, if you're fixing a particular issue (e.g.: test: create unit test for new user (#44)). Please visitCONTRIBUTING.md for more details.

3. Answer questions: You know the answer to another user's problem? Share your knowledge!

4. Provide your opinion: Your input might be helpful even if it is just an up- or down-vote.

5. Provide a more refined ui spec for existing feature requests

6. Report bugs

7. Make a feature or improvement request: Something can be be done better? Something essential missing? Let us know!

8. Design, ideas, planning, project management, etc.: You don't have to be programmer to help! See the this list on all-contributors for more ideas.

Installation and local development

These instructions will get a copy of the project on your local machine for development and testing purposes. If you have any further questions, feel free to reach out to Wil Gerard.

Prerequisites

• Node v16 or higher
• Yarn v3.2.0

Installation and setup

For instructions on installing Node, please visit https://nodejs.org/

Installing Yarn 2 (aka Yarn Modern)

npm install -g yarn
yarn set version berry

Clone repo

git clone https://github.com/wil-gerard/git-connected.git

Install dependencies

yarn

Environment variables

• You will find a .env template at git-connected/server/.envTEMPLATE

• Delete "TEMPLATE" from the filename

• MONGODB_URL: Instructions on setting up a MongoDB Atlas account. Refer to the image below on where to find your connection string.

  

• DISCORD_CLIENT_ID and DISCORD_SECRET: Instructions on setting up a Discord OAuth application

  • Redirect URI: http://localhost:4000/api/auth/discord/callback

The previous two environment variables should be enough for most development adjustments. But if you'd like full app functionality, feel free to add the other environment variables.

• TWITTER_CONSUMER_KEY and TWITTER_CONSUMER_SECRET: Create a Twitter OAuth app with v1.1 access
  • Redirect URI: http://localhost:4000/api/auth/twitter/callback
• GITHUB_CLIENT_ID and GITHUB_CLIENT_SECRET: Create a GitHub OAuth app
  • Redirect URI: http://localhost:4000/api/auth/github/callback

Developing locally

Open a terminal and run this script to start the dev server

yarn workspace server dev

In a new terminal, run this script to start the React client

yarn workspace client start

Contributors

Git Connected is developed collaboratively with folks across the globe. A huge thank you goes out to those helping make it happen (emoji key):

Wil Gerard 💻 📆 🚇 🎨 🤔 🚧 👀 🧑‍🏫 🐛 📖	Ken aka Frosty 💻 🚇 🤔 🚧 👀 🧑‍🏫 🐛	Gerard Strecker 💻 🤔 👀 🚧	Jeff Bucher 💻 🤔	Miracle 💻 🤔	Tim Jackson 💻 🤔 🐛	Dan Anderson 💻 🤔 🐛
Ivan Guzman 🤔	Nick Rooney 🤔	Sulthan Mohaideen 🤔	Kevin Deal 🤔 💻	Kevin Lindholm 🤔	Alejandro Ramirez Jr. 💬 🤔 🐛	Victoria Cheng 📖 🐛 💻

License

MIT License - see the LICENSE file for details