/far-nearer

Primary LanguageJavaScript

Who owns our neighbourhood?

alt text

The Challenges ⚠️

  • The End user needs a way to report potentially empty buildings in their area so that they can bring them into community ownership before they are bought by commercial buyers.
  • The Product owner needs a way to connect with these communities and gather the initial data so that they can run the initial investigations with the communities.

The Solution 💡

FAR NEARER website enables users to report about any empty buildings and the community members can access this data with provided credentials.

Design Sprint 🎨

alt text

Our Prototype

Installation Guide 🔧

  1. Clone this repo
  2. Navigate to the cloned repo

Project setup

  1. Create a .env file in the project root folder.
  2. Add the following in it This step is so important!!
AIRTABLE_BASE_ID
AIRTABLE_API_KEY
EMAIL
PASSWORD
  1. To install the dependecies, only for the first time:
 npm i && cd client && npm i --only the first time--

Running the project:

  1. To run the server, Open your terminal and run:

npm run dev
  1. To run the React Development server, Open another terminal and run:

cd client
npm start
  1. To run the tests:

npm test

User Journey

The user can visit the web-app to report buildings that are believed to be empty. Also, the user can see which buildings are empty and who owns them with all details for the building. The user can subscribe in the mailing list and recive emails with updates.

User Stories

  • As a user, I want to visit the website so that I can read about it.
  • As a user, I want report buildings that I believe it is empty so that I can share my information.
  • As a user, I want view information about the project so that I can deal with the displayed data.
  • As a user, I want subscribe to the mailing list so that I can receive emails with all updates.

Challenges Achieved 🎉

  • Finding a way for the community to find empty buildings easily 💯
  • Gave people oportuinty to report an empty building
  • Reduced the time and effort spent on finding empty buildings 🔥
  • Made a simple and easy to understand system
  • Making a good user experience for our users to use the app
  • Developed a strong 💪 backend and authentication system

Technologies 💻

  • Front-End: React JS
  • Back-End: Node JS & Express JS
  • Styling: CSS & Ant Design
  • Database: airtable

Team Members