Skip to content

Kinjo-team/kinjo_front

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation


KINJO

Share your neighborhood. Take a walk through someone else's.
Take a look under the hood »

See it in action · Report Bug · Request Feature

Table of Contents
  1. About KINJO
  2. Getting Started
  3. Roadmap
  4. Contributing
  5. License
  6. The KINJO Team
  7. Acknowledgments

About The Project

KINJO is a Tokyo-based project rooted in the belief that the quiet sidestreets, little towns and urban parks that you don't see in the big city guidebooks have their own story to tell. Taking its name from the Japanese word for neighborhood, KINJO lets you create maps and itineraries of your Tokyo neighborhood and share them with others.

(back to top)

Built With

  • Typescript
  • React
  • Leaflet
  • Sass
  • Firebase

(back to top)

Getting Started

A quick-start guide is provided below.

Prerequisites

  • npm
    npm install npm@latest -g

Installation

  1. Clone the repo
    git clone https://github.com/Kinjo-team/kinjo_front.git
  2. Install NPM packages
    npm install
  3. Start the KINJO Frontend
    npm start
    

(back to top)

Future Development Roadmap

  • Edit Kinjos
  • Collaborative Kinjos

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

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

(back to top)

License

Distributed under the MIT License.

(back to top)

The KINJO Team

Terrence Chu - @RatedYK
Evan Peterson - @evan-desu
Garrett Omi - @garrettomi
Alex Fisher - @cuspofcreation

KINJO Backend: KINJO Frontend

(back to top)

Acknowledgments

(back to top)