/shiny-system20

Primary LanguageCSS

PROJECT_NAME

Project Description

Connected Repositories

This Project consists of three Repositories:

  • Official Website. It can be accessed HERE
  • PROJECT_NAME Backend. It can be accessed HERE

Deployments

The PROJECT_NAME Backend and API, PROJECT_NAME and Smart Player applications are deployed at the following links:

PROJECT_NAME API

Vercel Link

PROJECT_NAME Web Application

Netlify Link

Specifications Document

The project specifications were prepared by PRODUCT_MANAGER_LINKEDIN with meetings with Product_Designer_LINKEDIN and SoftwareDeveloper_LINKEDIN.

Specs Link

Figma Prototype

The project was designed by Product_Designer_LINKEDIN with meetings with Product Manager and Development team.

Play with Figma

Built With

React Postgres

Linters

STYLELINT ESLINT PRETTIER

Requirements

To run the PROJECT_NAME API locally, the following requirements must be met:

  • Operating System: Any modern operating system (Windows, macOS, Linux)
  • Web Browser: Latest version of Chrome, Firefox, Safari, or Edge
  • Server: Node.js runtime environment

Installation

To install and set up PROJECT_NAME locally, follow these steps:

Clone

Clone the PROJECT_NAME repository from PROJECT_NAME with the command:

git clone git@github.com:USERNAME/project-name.git

Setup Environment

Install Node.js from Node.js website and configure it on your system.

Install Packages

Navigate to the root of project directory and run the following command to install the required dependencies

npm install

Run Server

Start the application server using the command

npm run dev

Local Server URL

Access the PROJECT_NAME Application at

http://localhost:5173/

Code Contributors

👤 Rao Akif


Acknowledgments

👤 Project Manager: USER NAME.

👤 Project Designer: USER NAME.

  • Thanks to my peers who are always there to offer support.
  • Contributions, issues, and feature requests are welcome!
  • Feel free to check the issues page.

Contributing

We welcome contributions from other developers to enhance PROJECT_NAME. To contribute to the project, please follow these guidelines:

  1. Fork the PROJECT_NAME repository and create a new branch for your feature or bug fix.
  2. Make your changes, ensuring they follow the project's coding conventions and best practices.
  3. Write unit tests to cover your code changes and ensure existing tests pass.
  4. Submit a pull request with a clear description of your changes and any relevant information.

Show your support

Give a ⭐️ if you like this project!

License

PROJECT_NAME is distributed under the MIT License. You are free to use, modify, and distribute the project under the terms of this license.