Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updated readme #7

Merged
merged 1 commit into from
Nov 2, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 2 additions & 3 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,8 @@ node_modules
/coverage

# production
/build
build
dist

# misc
.DS_Store
Expand All @@ -30,5 +31,3 @@ yarn-error.log*
.firebaserc
firebase.json
.firebase

dist
83 changes: 57 additions & 26 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,46 +1,77 @@
# Getting Started with Create React App
<p align="center">
<img src="src\assets\img\transparentBanner.png" />
</p>

This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
##

## Available Scripts
<p align="center">
<a href="#project-star2">Project</a>&nbsp;&nbsp;&nbsp;|&nbsp;&nbsp;&nbsp;
<a href="#techs-rocket">Techs</a>&nbsp;&nbsp;&nbsp;|&nbsp;&nbsp;&nbsp;
<a href="#installation-wrench">Installation</a>&nbsp;&nbsp;&nbsp;|&nbsp;&nbsp;&nbsp;
<a href="#test-heavy_check_mark">Test</a>&nbsp;&nbsp;&nbsp;|&nbsp;&nbsp;&nbsp;
<a href="#license-memo">License</a>
</p>

In the project directory, you can run:
##

### `yarn start`
<br>

Runs the app in the development mode.\
Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
## Project :star2:

The page will reload if you make edits.\
You will also see any lint errors in the console.
This repo contains a test for the Front-end Developer position at Méliuz.

### `yarn test`
<br>

Launches the test runner in the interactive watch mode.\
See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.
Deployed [here](https://seeker-meliuz.web.app/).

### `yarn build`
<br>

Builds the app for production to the `build` folder.\
It correctly bundles React in production mode and optimizes the build for the best performance.
<!-- <p align="center">
<img src="src\assets\img\project-1.gif"/>
</p>

The build is minified and the filenames include the hashes.\
Your app is ready to be deployed!
<br>

See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.
<p align="center">
<img src="src\assets\img\project-2.gif"/>
</p>

### `yarn eject`
<br> -->

**Note: this is a one-way operation. Once you `eject`, you can’t go back!**
## Techs :rocket:

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.
- [x] [ReactJS](https://reactjs.org);
- [x] [Node.js](https://nodejs.org/);
- [x] [TypeScript](https://www.typescriptlang.org/);
- [x] [Styled Components](https://styled-components.com/).

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.
<br>

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.
## Installation :wrench:

## Learn More
First you need to clone the project using `git clone https://github.com/leoronne/meliuz-frontend-test.git`.

You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).
Then you can install the application using `npm install` or `yarn install` on the root dir of the client and server folder.

To learn React, check out the [React documentation](https://reactjs.org/).
<br>

## Test :heavy_check_mark:

To start the application interface just run `npm start` or `yarn start` on the root dir of the folder.

<strong>Note: you need to create a .env file on the [server directory](<https://github.com/leoronne/meliuz-frontend-test/blob/master/server/.env.example>) and one on the [client directory](<https://github.com/leoronne/meliuz-frontend-test/blob/master/client/.env.example>) based on the example files.

You can generate the Comic Vine API Key [here](<https://comicvine.gamespot.com/api/>).

</strong>

<br>

## License :memo:

[![License](http://img.shields.io/:license-mit-blue.svg?style=flat-square)](http://badges.mit-license.org)

- **[MIT license](https://github.com/leoronne/meliuz-frontend-test/blob/master/LICENSE)**
- Copyright 2020 © <a href="https://github.com/leoronne" target="_blank">Leonardo Ronne</a>.

##
4 changes: 1 addition & 3 deletions client/.env.example
Original file line number Diff line number Diff line change
@@ -1,3 +1 @@
REACT_APP_API_KEY= # Gamespot API Key

REACT_APP_API_URL=https://comicvine.gamespot.com/api/
REACT_APP_API_URL= # API URL
65 changes: 65 additions & 0 deletions client/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
# Logs
logs
*.log
npm-debug.log*
yarn-debug.log*
yarn-error.log*
firebase-debug.log*

# Firebase cache
.firebase/

# Firebase config

# Uncomment this if you'd like others to create their own Firebase project.
# For a team working on the same Firebase project(s), it is recommended to leave
# it commented so all members can deploy to the same project(s) in .firebaserc.
# .firebaserc

# Runtime data
pids
*.pid
*.seed
*.pid.lock

# Directory for instrumented libs generated by jscoverage/JSCover
lib-cov

# Coverage directory used by tools like istanbul
coverage

# nyc test coverage
.nyc_output

# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
.grunt

# Bower dependency directory (https://bower.io/)
bower_components

# node-waf configuration
.lock-wscript

# Compiled binary addons (http://nodejs.org/api/addons.html)
build/Release

# Dependency directories
node_modules/

# Optional npm cache directory
.npm

# Optional eslint cache
.eslintcache

# Optional REPL history
.node_repl_history

# Output of 'npm pack'
*.tgz

# Yarn Integrity file
.yarn-integrity

# dotenv environment variables file
.env
Binary file added client/src/assets/img/socialBanner.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added client/src/assets/img/transparentBanner.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading