NoelLincoln/events-app-next

An application for users to add and find events

TechTide MeetUps

📗 Table of Contents

• 📖 About the Project

  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 🚀 Live Demo

• 💻 Getting Started

  • Setup
  • Prerequisites
  • Install
  • Usage
  • Run tests
  • Deployment

• 👥 Authors

• 🔭 Future Features

• 🤝 Contributing

• ⭐️ Show your support

• 🙏 Acknowledgements

• ❓ FAQ (OPTIONAL)

• 📝 License

📖 Techtide Meetups

Techtide Meetups is a tech event-management application built with the aim to connect developers around the world and locally to network and share knowledge.

🛠 Built With

Tech Stack

Client

• Next.js
• Tailwind CSS
• TypeScript
• Zod - Form validition
• ShadcnUI
• React Date Picker
• React Hook Form

Server

• Next.js
• UploadThing- Image Uploads
• Clerk - Authentication
• MongoDB
• Stripe

Design Tools

• Figma

Tools

• Visual studio code

Key Features

• Use of Webhooks
• User-friendly and Responsive
• Search using UseSearchParams from Next.js
• Pagination
• Payment using Stripe

(back to top)

🚀 Live Demo

Techtide Meetups

💻 Getting Started

To get a local copy up and running, follow these steps.

Prerequisites

In order to set up and run the application you need:

• A code editor preferably Visual Studio Code
• A web browser preferably Google chrome.

Basic requirements are needed in order to fully understand how the project fully works :

• Basic knowledge of HTML, CSS, React.js, Next.js, TypeScript.
• How Webhooks work
• How to work with Git and GitHub.
• Configuring CI/CD using github actions

Setup

Clone this repository to your desired folder:

  cd my-folder
  git clone https://github.com/NoelLincoln/events-app-next

Install

Install this project with:

  cd my-project
  npm install

Usage

Navigate to the root of the project and run the following command which will serve the project on http://localhost:3000 by default

  npm run dev

Run tests

To run tests(Disclaimer: Only a few test suites have been written). Jest is used as the testing library. Run the following command:

  npm run test

Deployment

You can deploy this project using Vercel

(back to top)

👥 Authors

👤 Noel Bryant

• GitHub: @githubhandle
• Twitter: @twitterhandle
• LinkedIn: LinkedIn

🔭 Future Features

• Virtual assistant
• Dark theme

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

If you like this project feel free to contact me.

(back to top)

🙏 Acknowledgments

I would like to thank the entire Microverse community and family for the support and motivation.

(back to top)

Image Credits

• freepik.com
• pngfind.com

License

📝 License

This project is MIT licensed.

(back to top)