Skip to content

Latest commit

 

History

History
198 lines (151 loc) · 7.63 KB

README.md

File metadata and controls

198 lines (151 loc) · 7.63 KB
Raw


Logo

Electra

The first meeting platform for film lovers

Table of Contents
  1. About The Project
  2. Getting Started
  3. Roadmap
  4. Contributing
  5. License
  6. Contact

About The Project

I wanted to create an application that would allow movie lovers to meet up and chat about their favorite films or series, and now it's done with Electra.

Quick tour of the application's flagship features

  • Chat with people who like the same movies as you using Space
  • Add movies to your favorites list
  • Rate the listed films in order to improve their referencing

(back to top)

Sequence diagram

Electra extends a huge functionality from TMDB, that's why you will need a TMDB account to use the application. Here is a sequence diagram for the authentication process used within the application:

Authentication sequence diagram

(back to top)

Built With

  • Next
  • [Socketio][Socket-io]
  • React Query
  • Prisma
  • TailwindCSS
  • Yarn
  • Nodemon
  • Context-API
  • Postgres

(back to top)

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites (dev)

  • Docker-compose
  • Yarn
  • Node.js version >=16.13.2.

Installation (dev)

  1. Get a free TMDB api key and access token by following this TMDB Documentation

  2. Clone the repo

    git clone https://github.com/younes101020/electra-v2.git

  3. Install NPM packages

    yarn install

  4. Create .env.development file in root path and copy the content of .env.example into it, make sure to fill empty variables with your credentials

    TMDB_API_KEY=""
TMDB_ACCESS_TOKEN=""
NEXT_PUBLIC_BASEURL="http://localhost:3000"
BASETMDBURL="https://api.themoviedb.org/3"
DATABASE_URL=""
JWT_SECRET_KEY=""

  5. Initially your database should be empty you have to use this command to apply electra migrations into it:

    yarn migrate:deployondev

(back to top)

Roadmap

  • Database modeling into prisma schema
  • Setup auth with extending tmdb auth
  • moove auth checking from layout to middleware
  • Perform full text show research
  • Init text lounge Space on first click for each entity
  • add movie page and display all related movie entity like actors..., we should be able to rate the movie from this page
  • Automate the creation of specialized ai for each Space, the ia must be able to answer all questions relating to the current show (more ai related feature should come in the future)
  • Multi-language Support
    • English (urgent)
    • French

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.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  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

(back to top)

License

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

(back to top)

Contact

Younes Fakallah - @untilsw

(back to top)