Kiroku - Show Tracking Application

Kiroku is a full-stack web application that helps you track shows in various states using Vue 3, Express.js, and MongoDB Atlas. Basic JWT authentication is implemented to secure API endpoints by verifying the identity of clients through digitally signed tokens stored locally in each browser session.

Prerequisites

Before you begin, ensure you have the following installed:

• Node.js (v16 or higher)
• npm
• MongoDB Atlas account
• Git

Installation

1. Clone the Repository

git clone https://github.com/simplicity0308/Kiroku.git
cd Kiroku

2. Setup Environment Variables

Create a .env file in the project root:

# Create the .env file
NODE_ENV=development
MONGO_URI=your_mongodb_atlas_connection_string" 

your_mongodb_atlas_connection_string is removed for privacy.

3. Backend Setup

Install the backend dependencies and start the server:

# Install backend dependencies
npm install

# Start the backend server
npm start

The server will run on http://localhost:3000.

4. Frontend Setup

Navigate to the frontend directory and install dependencies:

# Navigate to frontend directory
cd frontend

# Install frontend dependencies
npm install

# Start the development server
npm run dev

The Vue application will run on http://localhost:5173.

Development Scripts

Backend

# Run backend server (in root folder)
node server.js

Frontend

# Run frontend in development mode
cd frontend
npm run dev

# Build frontend for production
cd frontend
npm run build

MongoDB Atlas Setup

1. Create a MongoDB Atlas account
2. Create a new cluster
3. Create a database user with read/write permissions
4. Whitelist your IP address in the Network Access settings
5. Get your connection string from the "Connect" button on your cluster
6. Replace placeholders in the connection string with your username and password