Skip to content

Latest commit

 

History

History
125 lines (72 loc) · 4.08 KB

README.md

File metadata and controls

125 lines (72 loc) · 4.08 KB
Raw

SpaceCats app

Overview

The SpaceCats Library app is a React Native application developed with Expo. This project is solely for my training purposes to improve my skills in React Native, TypeScript,, Node,js, Express.js as well as using REST APIs and Expo. The app was not developed for public use.

Goal setting

The main goal of this app is to give me the opportunity to try out different technologies and development skills. The application allows one to retrieve cat images, GIFs and memes from an external API. There is no intention to use the app for commercial or public purposes.

Functionalities

1. Image retrieval

The app allows fetching cat images, GIFs and memes from an external API. For this idea I used the free version of the Cat API from thecatapi.com.

2. Rating function

There is an option to rate images and comments to express your preferences for certain content.

3. Comment function

The app allows you to leave your thoughts as a comment (there is no storage option as a cloud service) as this is just a practice project.

Technologies

  • React Native
  • TypeScript
  • Expo
  • REST API
  • Node.js
  • Express.js

Screenshots

Onboarding Screen

No Data Found Screen

Collection Screen

Loading Screen

Details Screen

Details Comments

Details Keyboard

Live Review

[Link to Live Review](https://youtu.be/sAxkvb925FM)


How to run this app

First of all, make sure you have installed Node.js global and Express.js global for the backend and obtained your own API key for free from https://thecatapi.com.
And also put the key in an .env file in the app directory.


Start Backend

To start the backend, run the following command:

npm run start:backend

This will start the backend on port 8021 and connect to the API using the key stored in the .env file.


Start frontend in the Android emulator

  1. Download and install Android Studio if you haven't already.
  2. Open Android Studio and select "Project" -> "More Actions" -> "Virtual Device Manager".
  3. Select a virtual device type (e.g. Pixel 4a, Pixel 6 or Pixel C) and load the frontend.
  4. Make sure the backend is running before starting the frontend.
  5. Start the frontend in the terminal with the command:
npm start

If you have trouble running the app try: 

npm start --reset-cache

Development Status

This project is in ongoing development and will be used exclusively for my private training purposes. If you have any questions or suggestions, please create an issue or submit a pull request.

License

This project is licensed under the MIT License. Please see the license file for more information.