codir

README

Codir

Community-sourced coding tutorials.

Description

Codir is a platform for discovering and sharing coding tutorials from around the web. It aims to create a one-stop destination for developers to find high-quality, relevant tutorials for a wide range of programming languages, libraries, frameworks, and other technologies.

With Codir, users can easily find tutorials tailored to their preferred learning style, experience level, and desired technologies. Whether you're a beginner diving into the world of programming or an experienced developer looking to expand your skills, Codir has something for everyone.

Running The Application

Note: Currently, in order to run the application locally, you must have access to the database. If given access you will be provided with a password that can be used as detailed below.

To run the application locally, the following steps must be taken:

1. Clone the GitHub repository
2. Open the terminal and navigate to codir/frontend/my-app
3. Type npm i to install all necessary frontend dependencies
4. Head to codir/backend/src/main and create a new file named .env
5. If given access to the database, type into the file DB_PASS={password} without the braces.
6. Head back to codir/frontend/my-app and type npm start to concurrently start up the backend and frontend

Contributors

Front End: Pranet Allu & Ansh Kalariya
Back End: Michael Pangas & Tyler Berndt