Gist Scan

This project was developed as a technical test.

---

👀 Demo

💡 About this challenge:

On this project was developed a mobile app that allows users comment on Github Gist.

• The user must open the Gist trough a QRCode Scan

More info about this challenge here on original file

⚙️ API

The use of the Github GIST API is mandatory. You can access it through the following link;

📚 Some used Libraries

• lottie-react-native => Used to render animations;
• react-native-app-auth => Used to authenticate the user on Github;
• react-native-qrcode-scanner => Used to read QRCode with your smartphone camera;
• react-native-syntax-highlighter => Used to render the Gist code;
• react-native-vector-icons => Used to render icons;
• styled-components => Used to create css styles;

🧪 Tests:

Implementation of unit tests in this project was started using Jest;

To run the tests just run the following command at the root of the project:

$ yarn test

The test details will be displayed on your console.

If you prefer, run the following command to generate the coverage folder

$ yarn test --coverage

🏁 Running the project:

1 - To run your project for the first time you will need to create a folder..

$ mkdir <your folder>

2 - Now enter the created folder.

$ cd <your folder>

3 - Let's clone the repository.

$ git clone https://github.com/Fred-Reis/gist-scan

4 - Run the following command to create the node_modules folder

$ yarn

5 - To install dependencies in IOS project using cocoa pods

$ cd ios

$ pod install

6 - Now, if you want to run this project on the emulator or device in development mode, run this command using your preferred platform.

$ yarn <your-preferred-platform>

7 - But if you wanna test on your Android device the .apk file is located at android/app/build/outputs/apk/release/app-release.apk

😃 If you got here it is a sign that everything went well and you can now scan your qrcode and comment on a gist. 🚀

"Stay hungry stay foolish!"

---

Author: Frederico Reis

make with ♥️