-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #19 from Astrid88/feat/add-readme
add readme
- Loading branch information
Showing
1 changed file
with
30 additions
and
65 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,68 +1,33 @@ | ||
| This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app). | ||
|
|
||
| ## Available Scripts | ||
|
|
||
| In the project directory, you can run: | ||
|
|
||
| ### `npm start` | ||
|
|
||
| Runs the app in the development mode.<br> | ||
| Open [http://localhost:3000](http://localhost:3000) to view it in the browser. | ||
|
|
||
| The page will reload if you make edits.<br> | ||
| You will also see any lint errors in the console. | ||
|
|
||
| ### `npm test` | ||
|
|
||
| Launches the test runner in the interactive watch mode.<br> | ||
| See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information. | ||
|
|
||
| ### `npm run build` | ||
|
|
||
| Builds the app for production to the `build` folder.<br> | ||
| It correctly bundles React in production mode and optimizes the build for the best performance. | ||
|
|
||
| The build is minified and the filenames include the hashes.<br> | ||
| Your app is ready to be deployed! | ||
|
|
||
| See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information. | ||
|
|
||
| ### `npm run eject` | ||
|
|
||
| **Note: this is a one-way operation. Once you `eject`, you can’t go back!** | ||
|
|
||
| If you aren’t satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project. | ||
|
|
||
| Instead, it will copy all the configuration files and the transitive dependencies (Webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own. | ||
|
|
||
| You don’t have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it. | ||
|
|
||
| ## Learn More | ||
|
|
||
| You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started). | ||
|
|
||
| To learn React, check out the [React documentation](https://reactjs.org/). | ||
|
|
||
| ### Code Splitting | ||
|
|
||
| This section has moved here: https://facebook.github.io/create-react-app/docs/code-splitting | ||
|
|
||
| ### Analyzing the Bundle Size | ||
|
|
||
| This section has moved here: https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size | ||
|
|
||
| ### Making a Progressive Web App | ||
|
|
||
| This section has moved here: https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app | ||
|
|
||
| ### Advanced Configuration | ||
|
|
||
| This section has moved here: https://facebook.github.io/create-react-app/docs/advanced-configuration | ||
|
|
||
| ### Deployment | ||
|
|
||
| This section has moved here: https://facebook.github.io/create-react-app/docs/deployment | ||
|
|
||
| ### `npm run build` fails to minify | ||
|
|
||
| This section has moved here: https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify | ||
| ## Table of content | ||
| * [The API](#The-API) | ||
| * [How to start](#How-to-start) | ||
| * [Technologies used for this project](#Technologies-used-for-this-project) | ||
| * [Contributors](#Contributors) | ||
|
|
||
| ## The API | ||
| This project uses content from [The Movie Data Base API](https://www.themoviedb.org/) version 3 | ||
| API documentation: | ||
| Overview: [https://www.themoviedb.org/documentation/api] | ||
| Getting started: [https://developers.themoviedb.org/3/getting-started/introduction] | ||
| To use the API you need to register and get an api_key [https://www.themoviedb.org/account/signup] | ||
|
|
||
| ## How to start | ||
| To start working on this project you can download or clone this repository, after you can: | ||
|
|
||
| 1. Run `npm install` on your terminal to install all the dependendencies | ||
| 2. Create in the app directory a .env file and add your api_key as `REACT_APP_MOVIES_API_KEY=<the api_key here>` | ||
| 3. Run `npm start` to get a preview of the front end | ||
|
|
||
| ## Technologies used for this project | ||
| 1. React with `create-react-app` | ||
| 2. `redux` and `react-redux` to set up a redux store and dispatch actions | ||
| 3. `react-router` and `react-router-dom` to use routes in react and have dom elements that work with them | ||
| 4. `superagent` to fetch data from the database | ||
| 5. `redux-thunk` to dispatch actions for the redux store | ||
| 6. `react-leaf-carousel` to show carousels in homepage [Documentation](https://github.com/leaffm/react-infinite-carousel#readme). | ||
| 7. `vimond-replay` to load HLS videos with `shaka-player`[Documentation](https://github.com/vimond/replay) | ||
| 8. `shaka-player` to load HLS videos [Documentation](https://github.com/google/shaka-player) | ||
| 9. `mux.js` to improve the loading of HLS videos [Homepage](https://github.com/videojs/mux.js/) |