City Tales

Experience the untold stories of vibrant cities with City Tales - where every journey is a tale waiting to be told.

Development

Prerequisites

• Node.js (v14.17.0)
• Yarn (v1.22.10)

Installation

1. Clone the repository

git clone https://github.com/akshatmittal61/city-tales.git

2. Install dependencies

yarn

3. Create a .env.local file in the root directory and add the following environment variables:

NEXT_PUBLIC_APP_DB_URI={{ YOUR_MONGODB_URI }}
NEXT_PUBLIC_APP_JWT_SECRET={{ YOUR_JWT_SECRET }}
NEXT_PUBLIC_API_URL={{ YOUR_API_URL }}

4. Run the development server

yarn dev

5. Open http://localhost:3000 with your browser to see the result.

Deployment

This project is deployed on Vercel.

Deployment on Vercel

1. Production deployment: city-tales.vercel.app/
2. Development deployment: city-tales-git-dev-akshatmittal61.vercel.app/

Built With

• Next.js - React framework
• TypeScript - JavaScript superset
• SASS - CSS preprocessor
• Jest - JavaScript testing framework
• Prettier - Code formatter
• ESLint - Linter
• Husky - Git hooks
• MongoDB - Database
• Mongoose - MongoDB object modeling

Authors

Akshat Mittal

License

This project is licensed under the MIT License - see the LICENSE file for details.

Acknowledgments

• Next.js
• Vercel
• MongoDB
• Mongoose
• React
• TypeScript
• SASS
• Jest
• Prettier
• ESLint
• Husky
• React Icons

Contributing

Contributions, issues and feature requests are welcome! Read the contributing guidelines to get started.

Show your support

Give a ⭐️ if this project helped you!