Expedius

Find, organize, and share your favourite places from around the world.

View Live · Report Bug · Request Feature

Table of Contents

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

About The Project

(back to top)

Built With

• 
• 
• 
• 
• 
• 
• 

(back to top)

Getting Started

Prerequisites

• Node.js 18+ and pnpm

• PostgreSQL database (or Neon.tech account for serverless PostgreSQL)

• Google Places API key

• Uploadthing account

• Upstash Redis account

Installation

1. Clone the repo

   git clone https://github.com/lucaswinkler/expedius.git

2. Install packages

   pnpm install

3. Copy the .env.example file to .env and fill in the variables

4. Run the development server

   pnpm run dev

5. Open http://localhost:3000 to view it in the browser.

(back to top)

Roadmap

• Filtering, sorting, and searching for lists
• Social features?
  • Followers
  • Following
  • Feed

(back to top)

Contributing

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)

Top contributors:

License

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

(back to top)

Contact

Lucas Winkler - @LucasJWinkler - lucaswinkler@gmail.com

Project Link: https://github.com/lucaswinkler/expedius

(back to top)

(back to top)