Code Monkey home page Code Monkey logo

yuriscodingclub / sos-animals Goto Github PK

View Code? Open in Web Editor NEW
44.0 2.0 11.0 12.68 MB

This app will help abandoned animals get help from Animal welfare organizations all over the world when people reporting them via this app.

Home Page: https://sos-animal.netlify.app/

License: MIT License

HTML 1.22% TypeScript 18.52% SCSS 3.73% Shell 0.06% JavaScript 69.34% CSS 2.14% MDX 4.99%
react figma reactjs react-router scss appwrite auth git github

sos-animals's Introduction

Description

code style: prettier

This app will help abandoned animals get help from Animal welfare organizations all over the world when people reporting them via this app. This project was initally created to participate in my first hackathon - Clerk x Hashnode Hackathon July 2021. Check out my article about the project and my experience in the hackathon.

๐Ÿ† This project was one of the Runner Up Winners. ๐Ÿฅณ

Blog article: SOS Animals app - a project for the Clerk x Hashnode Hackathon

Thumbnail

The idea is that when reporting an animal, the user will start filling out a form about the animal's situation and location. If people want to leave their contact information in the last stage, this should give them the possibility to stay connected with the NGOs and get information about the condition of the animal. When submitting the form, the form should be sent to the nearest NGO station.

To participate in the Hackathon, it was a requirement to implement Clerk Authantication, but it was finally removed because no authantication should be necessary to use the app, to make sure to help the animal as fast as possible.

Demo

Live view by clicking the badge: Netlify Status

You can also clone the project and open it in localhost, or enjoy the preview video below instead ๐Ÿ˜„

sos.animal.preview.mov

Contribution

To contribute to this project please check out the contribution guidelines.

Prerequisits

Before cloning/forking this project, make sure you have the following tools installed:

Installation

  1. Fork the project
  2. Clone the project
  3. Follow the instructions in the console:
  4. Navigate to the project directory cd sos-animals
  5. Install the dependencies npm install
  6. Run the project npm start

Contributors

sos-animals's People

Contributors

dependabot[bot] avatar imgbotapp avatar yuridevat avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

sos-animals's Issues

Create tests for the app

The app should be properly tested (Jest, React Testing Library, Cypress)

  • endpoints
  • unit tests
  • visual tests

Future of the project

Hi Julia.
The idea for this project is pretty cool!
Do you plan to go on with it in the future, or was it just for the hackathon?

Store data in localStorage

The data should be stored in localStorage, so it will still be there when the user clicks the next or previous button.

Add information to menu links

The links in the menu bar should point to the relevant page.
NGOs should be contacted and involved in the project

Keep code clean - DRY

As the code gets bigger, the folder structure should be adjusted (utils, libs,..)
To write clean code, TypeScript should be used
To improve the performance of the app, async/await functions should be used, error and load handling should be implemented, ...

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.