Skip to content

Latest commit

 

History

History
166 lines (115 loc) · 5.25 KB

Readme.md

File metadata and controls

166 lines (115 loc) · 5.25 KB

Logo

We help students and freshers build their career portfolios by encouraging them to contribute to open-source projects


Table of Contents
  1. About The Project
  2. Getting Started
  3. Roadmap
  4. Contributing
  5. License
  6. Contact
  7. Acknowledgments
  8. Founder
  9. Core Team

About The Project

As a new programmer, you have a tremendous opportunity to learn and create fantastic softwares.

Techpro club is a platform to help you hone your programming skills and learn to collaborate with people early on in your career.

While you contribute to projects, ask questions, and share your knowledge, we track them down in one place and help you build a better portfolio.

Our core services to the open source projects will be free forever. Feel free to contribute to our repository

(back to top)

Built With

(back to top)

Getting Started

Get a copy of Golang and Mongodb on your system and follow the Installation instructions.

Optional - For sending emails, read this document

Prerequisites

Github Project

Github project is needed to authenticate users. You may do so by visiting https://github.com/settings/apps. Note the Client ID and Client secret. Also, set two Callback URLs for project and contributor authentication.

Note - Create a Github App and not OAuth App because the later doesn't permit multiple callback URLs.

Installation

  1. Clone the repo

    git clone https://github.com/ClubTechPro/techpro.club.git

  2. Set Environment variables Rename the src/.env.sample to src/.env and replace with actual credentials obtained from the steps mentioned in Prerequisites.

  3. Install Golang dependencies

    cd /path/to/project
go mod tidy

  4. Run the project

    go run main.go

    Open a browser and hit http://localhost:8080. If you want to host the application on your own server, read this

(back to top)

You will need to create OAuth projects in Github and Google and place these values in Callback URL

Github Callback URL GB_CONTRIBUTOR_REDIRECT_URI=http://localhost:8080/contributors/github/callback GB_PROJECT_REDIRECT_URI=http://localhost:8080/projects/github/callback

Google Callback URL GO_CONTRIBUTOR_REDIRECT_URI=http://localhost:8080/contributors/google/callback

Edit However, we do not use GB_PROJECT_REDIRECT_URI anymore. You can safely use the other two

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Techproclub -

Links -

(back to top)

Project Founders