mikiyas-girma / alx-devs

Empowering students to collaboratively build diverse projects, enhance their portfolios, and gain real-world teamwork experience.

Alx_Devs

Introduction

Alx_Devs is a platform designed to connect developers for collaborative projects, enabling them to build strong portfolios and gain valuable experience. Whether you're looking to contribute to an open-source initiative or join a startup team, Alx_Devs helps you find projects that match your expertise and passion.

Deployed Site: Alx_Devs

Installation

To run the Alx_Devs project locally, follow these steps:

1. Clone the repository:

   git clone https://github.com/mikiyas-girma/Alx-Devs.git
   cd alx_devs

2. Set up the virtual environment for the backend:

   cd backend
   python -m venv venv
   source venv/bin/activate  # On Windows, use: venv\Scripts\activate

3. Install backend dependencies:

   pip install -r requirements.txt

4. Set up the frontend:

   cd frontend
   npm install

5. Run the backend server:

   cd backend
   py -m api.v1.app

6. Run the frontend server:

   cd frontend
   npm run dev

Usage

1. Registration: Sign up by providing your username, email, and password.
2. Login: Access your account using your registered email and password.
3. Create Project: Post new projects with detailed descriptions and requirements.
4. Join Projects: Browse and request to join projects that interest you.
5. Manage Requests: Approve or reject requests to join your project.

Screenshots

This is the current landing page to be changed soon!

This is the page where created project get listed

This is the profile page in Dark Mode nb. the web app is have both light & dark mode

this is the page where users after logged in create a project and find potential teammates

Contributing

We welcome contributions to Alx_Devs! To contribute:

1. Fork the repository.
2. Create a new branch:

   git checkout -b feature/your-feature-name

3. Make your changes.
4. Commit your changes:

   git commit -m "Add feature description"

5. Push to the branch:

   git push origin feature/your-feature-name

6. Open a pull request.

Related Projects

• Anonymously ask & reply telegram bot

Licensing

This project is licensed under the MIT License. See the LICENSE file for details.