miraclebanks/git-connected

A social networking application to help connect the 100Devs community

GitConnected

GitConnected 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
• Installation and setup
• Contributing ♥️
• Authors
• License

Features

Made by and for the 100Devs community

User login that only allows members of the 100Devs Discord server. Connect your GitHub, Twitter, and LinkedIn accounts.

Connect across Twitter, GitHub, LinkedIn, 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 check out the CODE_OF_CONDUCT.md

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 angular commit guidelines 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).

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, project management, translations, etc.: You don't have to be programmer to help!

Installation and setup

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

Installing

• Clone repo git clone https://github.com/wil-gerard/GitConnected
• Install NPM modules for backend cd backend and then yarn install
• Install NPM modules for client cd client and then yarn install
• Create an .env file with your own environment variables:

.env

Expects a .env file in the root directory of backend with environment variables. If you're unsure what that means, locate our template .envTEMPLATE, delete "TEMPLATE" from the filename, plug in your environment variables, and save.

Running locally

Frontend

• Navigate to root directory of client in your terminal cd client and then yarn start

Backend

• Navigate to root directory of backend in your terminal cd backend and then yarn dev

Authors

• Wil Gerard - Software Engineer - wil-gerard
• Ken aka Frosty - Software Engineer - KenAKAFrosty
• Jeff Bucher - Software Engineer - JeffBucherDev

See also the list of contributors who participated in this project.

License

MIT License - see the LICENSE.md file for details