![Logo](https://raw.githubusercontent.com/chingu-voyages/v44-tier3-team-29be/main/./public/artemis-icon.png)
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
Table of Contents
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.
Frontend:
- Next.js
- TypeScript
- TailwindCSS
Backend:
- Node.js
- Express.js
- TypeScript
Database:
- MongoDB
Anna | Devim | Horus | Lei |
---|---|---|---|
To get a local copy up and running follow these simple example steps.
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.
- Clone the repo
git clone https://github.com/chingu-voyages/v44-tier3-team-29.git
- Install NPM packages
npm install
- Start the development server
npm run dev
- To view your application go to
http://localhost:3000
- 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).
Distributed under the MIT License. See LICENSE.txt
for more information.
Ha Anna - @haanna_dev - anna@haanna.com
Devim - @d3v1m - developerimalka@gmail.com
Horus H. - @nubi_vago - h.horace0921@gmail.com
Lei - @twitter_handle
Project Link: https://github.com/chingu-voyages/v44-tier3-team-29