Skip to content

Latest commit

 

History

History
112 lines (76 loc) · 2.86 KB

README.md

File metadata and controls

112 lines (76 loc) · 2.86 KB
Raw

ALX Hall of Fame License: MIT React Material-UI Tailwind CSS Django

ALX Hall of Fame

ALX Hall of Fame serves as a repository for projects developed by ALX students and alumni. The goal is to inspire people, instigate creativity, and ignite collaboration.

Table of Contents

Description

The ALX Hall of Fame is designed to be a central repository where ALX students and alumni can showcase their projects. This platform aims to inspire innovation and foster collaboration among developers.

Features

  • Project Repository: A place for students and alumni to upload and showcase their projects.
  • Inspiration Hub: Browse projects to get inspired and find new ideas.
  • Collaboration Platform: Connect with other developers to collaborate on projects.

Installation

To get a local copy up and running, follow these simple steps.

Prerequisites

  • Node.js
  • npm (Node Package Manager)
  • Python
  • Django

Backend Setup

  1. Clone the repository:

    git clone https://github.com/bravemaster3/alx-hall-of-fame.git
cd alx-hall-of-fame

  2. Create and activate a virtual environment:

    python -m venv venv
source venv/bin/activate   # On Windows: venv\Scripts\activate

  3. Install backend dependencies:

    pip install -r requirements.txt

  4. Run the Django server:

    python manage.py migrate
python manage.py runserver

Frontend Setup

  1. Navigate to the frontend directory:

    cd frontend

  2. Install frontend dependencies:

    npm install

  3. Start the React development server:

    npm start

Usage

  1. Open your browser and navigate to http://localhost:8000 to view the backend.
  2. Navigate to http://localhost:3000 to view the frontend.

Adding a Project

  1. Click on the "Add Project" button.
  2. Fill in the project details and submit.

Contributing

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

  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

License

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