Giter Club home page Giter Club logo

moviehunt's Introduction

Welcome to MovieHunt!

MovieHunt is a modern web app that allows you to browse through movies and view their ratings, synopses, release years and so on. This enables you to make informed decisions on which ones you wish to see at a cinema, which ones you'll like to buy as DVD and which ones you'll rather not see.

Table of Contents

  1. Our Tech Stack
  2. Installation and setup
  3. Contributing
  4. Licence

Our Tech Stack

This project was built using modern technology tools. These include:

  • Node.js- for running, compiling and serving the app.
  • Express.js- for running an HTTP server for the app.
  • React- for composing the various components used on the front-end.
  • Redux- for managing app data and app state on the front-end.
  • TypeScript- for most of the JavaScript written in this app (whether the JavaScript is for the back-end or the front-end).
  • Stylus- for designing the front-end. It eventually gets transpiled down to CSS.
  • Webpack- for transpiling from ES6+ to ES5, which is what most browsers understand.
  • Heroku- for deploying the app online.

Installation and setup

Here are the steps you need to follow to run this project on your computer:

  • Install Node.js: You may visit this link for complete instructions on installing Node.js on your computer. Note that you need version 8 or later of Node.js to run this app.

  • Install yarn: yarn is a package manager for Node.js packages. You may find its installation instructions over here. We prefer it to npm (and other package managers out there) because it is much faster and more efficient than npm.

  • Open a terminal/command prompt on your computer and cd (i.e change directory) into your preferred path/location.

  • Clone this repo: Enter this command in the terminal:

git clone https://github.com/folushooladipo/moviehunt.git
  • Install dependencies: Do this by running the following command:
yarn
  • Add the required environment variables: Consult the .env.sample file in the root of this repository for info about the different environmental variables you need to specify for this app. When you're done, save your changes in a .env file in the root of the repo.

  • Running the app: Enter the following command in the terminal:

yarn start

Wait for the app to start up. When you see a line of output in the terminal that says "App now running on port PORT", open a browser, visit localhost:PORT and you should see the app! Note that PORT will be the value you specified in .env. If you didn't specify your own desired port, PORT will be 5000.

Contributing

Found a bug? Let me know about it by creating a new issue at this link. If you would also like to contribute a solution, consult this document for instructions on how to create a fork of this project, implement your solutions and submit a pull request.

Similarly, if you want to help add a new feature, please use this document as a guide on how to fork this repo, add your feature(s) and submit a pull request.

Lastly, you can send your suggestions, feedback etc by tweeting at the Lead Developer, Folusho Oladipo.

License

This project is authored by Folusho Oladipo and is licensed for your use, modification and distribution under the MIT license. Feel free to hack, extend and share it!

Thanks and see you at the movies!

moviehunt's People

Contributors

dependabot[bot] avatar folushooladipo avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.