Skip to content

If it is about Open Source, it is on Opentek.

License

Notifications You must be signed in to change notification settings

SaiSathvik6/opentek

 
 

Repository files navigation

Opentek ⚡

opentek licence styler forks styler stars styler issues styler pull-requests

View Demo · Report Bug · Request Feature

Introducing Opentek 🎉

Welcome to Opentek, your No.1 source for Open Source Development. We're dedicated to giving you the very best of tools, resources, and projects, with a focus on Collaboration, Code, and Networking. Try out Opentek 🙌

🚀 Demo

😎 Features

  • 📱 Progressive Web App(PWA) Supported
  • User Authentication
  • Open Source EVENTS displayed Month-Wise (with a short desc, logo, and Website)
  • Open Source PROGRAMS displayed Month-Wise (with a short desc, logo, and Website)
  • 📚 Open Source related TUTORIALS hand-picked from the best in the domain embedded in our website (credits to the Author displayed)
  • 🔥 Domain-Specific Open Source PROJECTS from all around GitHub by amazing Open Source Developers where you can contribute (credits to Admin given)
  • 💻 Official Discord Channel solely dedicated to Open Source Development where you can showcase your projects and collaborate
  • 🌈 ANYONE!! YES ANYONE can contribute to this project and can make a difference.
  • 💥 Never miss out on any Events and Programs anymore and say bye-bye to the tedious google searches to find a tutorial or a Beginner-friendly project

OPEN SOURCE TO THE MOOON 🚀 Join our

🛠️ Installation Steps

  1. Fork this repository.
  2. Clone your forked copy of the project.
git clone --depth 1 https://github.com/<your username>/opentek.git
  1. Change the working directory.
cd opentek
  1. Add a reference to the original repository.
git remote add upstream https://github.com/Opentek-Org/opentek.git
  1. Check the remotes for this repository.
git remote -v
  1. Always take a pull from the upstream repository to your main branch to keep it up-to-date with the main project (updated repository).
git pull upstream main
  1. Create a new branch.
git checkout -b <your_branch_name>

You are all set! Open localhost:3000 to see the app. (Authenticated via Auth0)

Docker Setup

Opentek provides a Docker setup that allows you to run the application in a containerized environment. To use Docker with Opentek, follow these steps:

Make sure you have Docker installed on your machine. If not, you can download and install Docker from the official website: Docker Build the Docker image using the provided Dockerfile by running the following command:

   docker build -t opentek .

Once the Docker image is built, you can run a container using the following command:

docker run -p 3000:3000 opentek.

Open your web browser and visit http://localhost:3000 to access the Opentek application running inside the Docker container.

If you are using VS Code, you can use the live server extension to set up your local environment. Make sure to keep your Port number as 3000. This is required in order to use the authentication feature via Auth0 in your local env, for which the allowed port is set to 3000 as of now. More common ports will be added ASAP.

  1. Perfom your desired changes to the code base.

giphy.gif

  1. Track your changes.
git add .
  1. Commit your changes.
git commit -m "Relevant message"
  1. Push the committed changes in your feature branch to your remote repo.
git push -u origin <your_branch_name>

  1. To create a pull request, click on "Compare and pull requests". Please ensure you compare your feature branch to the desired branch of the repo you are suppose to make a PR to.

  2. Voila 🎉 You have made a PR to the Opentek project. Sit back patiently and relax while the project maintainers review your PR.

Please read our Code of Conduct, and the process for submitting pull requests to us.

🤷‍♂️ Want to submit an event, program, project or a tutorial to our Website?

Please read our contributing guidelines

💻 Built with

  • Auth0: User Authentication
  • HTML5: Skeleton
  • CSS3: Styling
  • Bootstrap 4 and 5: Rich Styling
  • JavaScript (Server and Client Side) : For Loading Data
  • Font Awesome: For Icons
  • Iconscout: For Icons
  • Rough Notation: A small JavaScript library to create and animate annotations on a web page
  • Netlify: For Hosting
  • Name.com: For Domain Name

👥Community Partners

     

👀 Future Plans

  • Conducting Community Own OPEN SOURCE PROGRAM.
  • Sorting out projects according to beginners, intermediate and advanced levels.
  • Participating in various Open Source programs with this project.
  • Collaborating with various communities and create opportunities.
  • Adding Hackathon Page and updating it month-wise.
  • Animations.
  • In-built blog posts related to Open Source and Networking.
  • Creating projects under Opentek and Open Sourcing them.

🌟 Deploy

Netlify Status

🙏 Support

This project needs a ⭐️ from you. Don't forget to leave a star ⭐️ It will motivate us!!

Opentek - If it is about Open Source, it is on Opentek. | Product Hunt


✌ Our Socials

About

If it is about Open Source, it is on Opentek.

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • HTML 58.8%
  • JavaScript 21.5%
  • CSS 17.8%
  • EJS 1.7%
  • Dockerfile 0.2%