Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/mrarvind90/fcc-ticketing-app

A full-stack ticketing web application built with NextJS, Tailwind CSS and MongoDB.
https://github.com/mrarvind90/fcc-ticketing-app

freecodecamp javascript mongodb mongoose nextjs tailwind-css

Last synced: 6 days ago
JSON representation

A full-stack ticketing web application built with NextJS, Tailwind CSS and MongoDB.

Awesome Lists containing this project

README

        

[![freeCodeCamp Social Banner](https://s3.amazonaws.com/freecodecamp/wide-social-banner.png)](https://www.freecodecamp.org/)


HTML5
CSS3
Javascript
NextJS
Tailwind CSS
NodeJS
NPM
ESLint
Prettier

# Ticketing App

A full-stack ticketing web application built with NextJS, Tailwind CSS and MongoDB.

This is a [Next.js](https://nextjs.org/) project bootstrapped
with [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app).

## Libraries / Frameworks / Databases Used

- **Application**
- NextJS
- Tailwind CSS
- **Database**
- MongoDB

## Pre-requisite

This project relies on MongoDB Atlas cloud instances for managing resources such as `/shorturl` and `/users`. If you
intend to clone this repository and run it locally, please follow these steps:

1. Create a MongoDB Atlas Account: To get started, you'll need to create an account on MongoDB Atlas, and the good news
is, it's absolutely free! You can follow the step-by-step instructions in the
[MongoDB Atlas Tutorial – How to Get Started](https://www.freecodecamp.org/news/get-started-with-mongodb-atlas/)
provided by freeCodeCamp to set up your own cluster.
2. Configure Your Environment Variables: After setting up your MongoDB Atlas cluster, you'll need to configure your
environment variables. To do this, rename the `.env.sample` file in your project directory to `.env`. Then, open the
`.env` file and insert the MongoDB URI from your Atlas cluster.

Here's what it should look like:

```dotenv
# Database variables
MONGODB_ATLAS_URI=mongodb+srv://:@/?retryWrites=true&w=majority
```

Note: In the example snippet above, you'll notice that the URI includes a database name. While this field is technically
optional, it's highly recommended that you create your own database instance on your MongoDB Atlas cluster. This
practice helps maintain organization and clarity in your project.

## Getting Started

1. Clone the repo:
```git
git clone [email protected]:mrarvind90/fcc-ticketing-app.git
```
2. Navigate to the repository:
```shell
cd
```
Change to the name of the cloned directory.
3. Install Dependencies:
```shell
npm install
```
This command will install all the necessary dependencies for the application.
4. Configure Environment Variables: Rename the `.env.sample` file in your project directory to `.env.local` and update
it with the
relevant credentials:
```shell
cp .env.sample .env.local
```
5. Run the application:
```shell
npm run dev
```

## Future Improvements

While developing this project, there are several areas I plan to focus on for enhancements and refinements
which can be found on [GitHub](https://github.com/mrarvind90/fcc-ticketing-app/issues).