jennifertakagi/worldtrip

A quick and simple travel tips blog, built with Next.js and Chakra UI!

WorldTrip

A quick and simple travel tips blog, built with Next.js and Chakra UI!
Explore the docs »

· Report Bug · Request Feature

Table of Contents

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

About The Project

A quick and simple travel tips blog, choose your next destination.

Features:

• Discover the biggest cities from all the 5 continents

Built With

• Axios
• Chakra UI
• JSON Server
• Next JS
• React Country Flag
• React Icons
• SASS
• Swiper
• TypeScript

Getting Started

Prerequisites

• npm

  npm install npm@latest -g

• yarn

  npm install --global yarn

Installation

1. Clone the repo

   git clone https://github.com/jennifertakagi/worldtrip.git

2. Install packages

   yarn | npm install

3. Run the following commands in root folder start the application in a development environment:

   yarn server | npm run server and yarn dev | npm run dev

Usage

Roadmap

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

Contributing

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

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

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Jennifer Takagi - @jennitakagi

Acknowledgements

• ESLint
• Prettier