An open API service indexing awesome lists of open source software.

https://github.com/benmukebo/hillwood-backend-dashboard


https://github.com/benmukebo/hillwood-backend-dashboard

Last synced: 30 days ago
JSON representation

Awesome Lists containing this project

README

          

# 📖 HillWood Empire

> HillWood-Empire" is an online streaming platform that provides users with a diverse selection of movies, TV shows, videos, and content for kids. It is a subscription-based service that allows users to access the platform on various devices, including smartphones, tablets, laptops, and smart TVs.



logo



### Tech Stack

Backend

  • Ruby

  • Ruby on Rails

  • PostgreSQL DB

  • Admin Dashboard

  • Active Admin

  • ActiveAdminTheme

  • ActiveAdminFlatSkin

  • Diagram

    ## Links 🔗

    - [Front-end App](https://hillwood-frontend-ui.vercel.app/)
    - [Backend API](https://)

    ### Key Features

    - Project setup 😊
    - App Api Integration 💯
    - Customer Admin Dashboard.🚀
    - Authentication Api and Admin Dasborad configuration 👌
    - User Authorization and permission 😃👍

    (back to top)

    ## 💻 Getting Started

    ### Prerequisites

    In order to run this project you need:

    - A web browser to view output e.g [Google Chrome](https://www.google.com/chrome/).
    - An IDE e.g [Visual studio code](https://code.visualstudio.com/).
    - Install the `npm` package manager use this [to install both node and npm](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm).
    - [A terminal](https://code.visualstudio.com/docs/terminal/basics).

    ### Create the database & Starting up the Web Server

    ```bash
    $ rails db:create db:migrate
    $ rails server

    // or you can run additionaly this to precompile tailwind asset and start the server

    $ bin/dev
    ```

    ### Install

    To install all dependencies, run:

    ```
    $ npm run install
    $ npm run dev
    ```

    ### Usage

    To run the project, follow these instructions:

    - After Cloning this repo to your local machine.
    - To get it running on your default browser and local host, run:

    1. Open the index with live server from the code editor
    2. Or you can double click on the index to open it in the browser

    ### Run tests

    To run tests, run the following command:

    - Track Ruby and css linter errors run:

    ```
    $ rubocop -A
    $ rubocop --auto-correct-all
    $ npx stylelint "**/*.{css,scss}"
    ```
    - Kill the server

    ```
    $ kill -9 PID
    $ pkill -f "ruby"
    $ rm tmp/pids/server.pid
    ```

    (back to top)

    ## 🎥 Future Feature

    -

    ## 🎥 Project Presentation

    - Project Presentation: will add soon

    (back to top)

    ## Contributors

    👤 **Ben Mukebo**

    - GitHub: [@Ben Mukebo](https://github.com/benmukebo)
    - Twitter: [@Ben Mukebo](https://twitter.com/BenMukebo)

    Contributions, issues, and feature requests are welcome!

    ## Show your support

    Give a ⭐️ if you like this project!

    ## 🤝 Contributing

    Contributions, issues, and feature requests are welcome!

    Feel free to leave any suggestions at the [Issues page](https://github.com/BenMukebo/hillwood-backend-dashboard/issues)

    (back to top)

    - The original design ideal from Feli Technology 💕.

    ## 📝 License

    This project is [Apache-2.0 license](./LICENSE.MD) licensed.

    (back to top)