Skip to content

cuspofcreation/kinjo_back

 
 

Repository files navigation

Contributors Forks Stargazers Issues MIT License


KINJO - Backend Server

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. Contact
  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
  • NodeJS
  • Express.js
  • Prisma
  • Axios

(back to top)

Getting Started

A quick-start guide is provided below. Make sure you have the KINJO Frontend: https://github.com/Kinjo-team/kinjo_front/

Prerequisites

  • npm
    npm install npm@latest -g

Installation

  1. Obtain Firebase API key/Frontend URLs and ensure this is in your .env

  2. Clone the repo

    git clone https://github.com/Kinjo-team/kinjo_back.git
  3. Install NPM packages

    npm install
  4. Start the KINJO backend server

    npm start
    

(back to top)

Future Development Roadmap

  • Support for editing itineraries
  • Group itinerary support

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 App: KINJO Frontend

(back to top)

Acknowledgments

(back to top)

Releases

No releases published

Packages

 
 
 

Languages

  • TypeScript 93.2%
  • JavaScript 4.0%
  • Python 1.9%
  • Other 0.9%