Skip to content

Latest commit

 

History

History
303 lines (214 loc) · 9.08 KB

README.md

File metadata and controls

303 lines (214 loc) · 9.08 KB
Raw

Contributors Forks Stargazers Issues


ARTISTS MANAGEMENT SYSTEM

Welcome to the Artists Management project repository! This project aims to create an Artists Management System/Platform for Swahilipot Hub members, which will enable better organization, presentation, and dissemination of artist's profiles and their works.Artists will be able to showcase their work and for art enthusiasts to discover, engage with, and support artists. Whether you're an artist, developer, designer, or just interested in art, we welcome your contributions and collaboration.

View Demo · Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Features and Functionalities
  4. Contributing
  5. License
  6. Contact
  7. Acknowledgments

About The Project

HomepageHomepage

PortfolioPortfolio

(back to top)

Built With

  • Next
  • Bootstrap
  • Python
  • Django

(back to top)

Getting Started

This section provides instructions on setting up the Swahilipot Artists Management System locally. It encompasses steps to initialize both the frontend and backend development environments within the monorepo structure.

Prerequisites

  • Python installed

  • Node.js installed

  • Git for version control

  • npm or yarn
    npm comes with Node.js installation. To install yarn:

    npm install -g yarn

  • npm or yarn
    pip usually comes with Python installation. To ensure it's up to date:

    python -m pip install --upgrade pip

Installation:

Frontend

  1. Clone the repo

    git clone https://github.com/Swahilipot-Hub-Developers/artists.git

  2. Navigate to Backend Directory:

    cd frontend

  3. Install Frontend Dependencies

    npm install   # or using yarn: yarn install

  4. Run the Frontend Development Server:

    npm run dev   # or using yarn: yarn dev

    (back to top)

Backend

  1. Navigate to Backend Directory:

    cd backend

  2. Create and Activate a Virtual Environment (Optional but Recommended):

    python3 -m venv venv         # Create a virtual environment
    source venv/bin/activate    # Activate the virtual environment (for Unix systems)

  3. Install Django and Dependencies:

    pip install -r requirements.txt

  4. Run Backend Migrations:

    python manage.py makemigrations
    python manage.py migrate

  5. Start the Backend server:

    python manage.py runserver

    (back to top)

Features

1. Database Filtering

  • Capability to filter artists based on criteria like name, talent/skill, work type, etc.
  • Advanced search functionalities for specific skills or talents.

2. Artist Profile

  • Image: High-quality artist profile picture.
  • Bio: Artist's background, inspirations, and journey.
  • Talents/Skills: Categorized list of skills or talents.
  • Work Done: Portfolio showcasing previous and current works (images, videos, audio clips, external project links).
  • Contact Details: Securely presented for potential clients or interested parties.

3. Work Sharing Capabilities

  • Artists can share, update, or remove their works.
  • Support for various media types: photos, videos, audio files, text descriptions.
  • User-friendly interface for easy sharing.

4. Security and Privacy

  • Secure storage of artist data, especially contact details.
  • Robust privacy settings for artists.
  • Control over who can view their contact details or personal information.

5. User Experience (UX) and User Interface (UI)

  • Visually appealing, intuitive, and easy-to-navigate platform.
  • Responsive design for accessibility across devices.

6. Notifications & Updates

  • Artists receive notifications for new comments, feedback, or interests in their works.
  • Option for artists to send out updates related to their work or events.

7. Implementation Considerations

  • Scalability for handling a large number of artist profiles and works.
  • Regular backup solutions to prevent data loss.
  • Incorporation of analytics to track user engagement and popular profiles.

For more examples, please refer to the Documentation

(back to top)

Roadmap

  • Feature 1
  • Feature 2

See the open issues for a full list of proposed features (and known issues).

(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.

  1. Fork the Project by clicking the "Fork" button at the top right of the repository page.

  2. Clone the forked repository to your local machine:

    git clone https://github.com/Swahilipot-Hub-Developers/artists.git

  3. Create your Feature Branch

    git checkout -b feature/AmazingFeature

  4. Commit your Changes

    git commit -m 'Add some AmazingFeature'

  5. Push to the Branch

    git push origin feature/AmazingFeature

  6. Open a Pull Request

(back to top)

License

Distributed under the MIT License.

(back to top)

Contact

Project Link: https://github.com/Swahilipot-Hub-Developers/artists

(back to top)

Acknowledgments

(back to top)

Stay tuned for updates and improvements! 🎉