leixdd / v44-tier3-team-29

Artemis - A crowd-sourced web application aimed at assisting stray animals and reducing their number on the streets. | Project completed during Chingu's 44th Voyage. | Frontend

Artemis

A crowd-sourced web application aimed at assisting stray animals in reducing their number on the streets.
View Demo (N/A) · Report Bug · Request Feature

⚠️ This is a repository that stores the frontend code, to see the backend code, go here.

Table of Contents

1. About The Project
   • Built With
   • Developers
2. Getting Started
   • Prerequisites
   • Installation
3. Roadmap
4. License
5. Contact
6. Acknowledgments

About The Project

Artemis is a full-stack web application built using MERN (MongoDB, Express.js, React.js, Node.js), Next.js, and TypeScript. The aim of this project is to provide assistance to stray animals in the user's area.

This crowd-sourced platform allows users to upload photos of stray animals that require attention or assistance. The primary objective of Artemis is to aid in reducing the number of stray animals on the streets by facilitating their rescue, rehabilitation, and adoption.

The name "Artemis" was chosen because it is the Greek God associated with animals and their protection. This project is inspired by the love and compassion that people have for animals and the desire to create a better world for them.

This project came into existence during Chingu's 44th Voyage which ran from May 1st, 2023 to June 11th, 2023.

(back to top)

Built With

Frontend:

• Next.js
• TypeScript
• TailwindCSS

Backend:

• Node.js
• Express.js
• TypeScript

Database:

• MongoDB

(back to top)

Developers

Anna	Devim	Horus	Lei

(back to top)

Getting Started

To get a local copy up and running follow these simple example steps.

Prerequisites

To install Next.js on your machine you will need:

• Node.js - Next.js requires Node.js version 10.13 or later. You can download and install Node.js from nodejs.org.
• npm (Node Package Manager) - npm is distributed with Node.js, so once you have installed Node.js, you have also installed npm. You can check your npm version by running npm -v in your terminal.

Installation

1. Clone the repo

   git clone https://github.com/chingu-voyages/v44-tier3-team-29.git

2. Install NPM packages

   npm install

3. Start the development server

   npm run dev
   

4. To view your application go to

   http://localhost:3000
   

(back to top)

Roadmap

• User registration and authentication for secure access to the platform
• Post creation to allow users to upload photos of stray animals that require attention or assistance
• Geolocation feature to show the location of the uploaded animals on an interactive map
• Search functionality for finding animals based on location and type
• Notification system to keep users updated on the status of their posts and relevant activities
• User profile management to enable users to manage their personal information and settings
• Post update and deletion capabilities to allow users to modify or remove their posts as needed.

See the open issues for a full list of proposed features (and known issues).

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Ha Anna - @haanna_dev - [e-mail]

Devim - @d3v1m - [e-mail]

Horus H. - @nubi_vago - [e-mail]

Lei - @AinAyeYel

Project Link: https://github.com/chingu-voyages/v44-tier3-team-29

(back to top)

Acknowledgments

• Chingu.io

(back to top)