Skip to content

chelsea-banke/log-r

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

71 Commits
 
 
 
 
 
 
 
 

Repository files navigation

Logbook Generator

This is a web application that lets you create and manage your internship logbooks

Features

  • Light/dark mode toggle
  • Live previews
  • Download in .docx or .pdf
  • Cross platform compatible

Tech Stack

  • Client: React, TailwindCSS

  • Server: Node, Express, Sequelize

  • DataBase Mysql

Requirements

  • mysql
  • nodejs
  • nodemon
  • vitejs

Run Locally

Clone the project

  git clone https://github.com/chelsea-banke/log-r.git

|

client side

Go to the project directory

  cd frontend

Install dependencies

  npm install

Run the project

  npm run dev

|

server side

Go to project directory

  cd backend

Create the project database

  mysql -u root -p
  > source absolute-path-to-repository/backend/src/configs/db-schema.sql

Setup your enviromental variables in a .env file

  echo "DB_NAME = 'logr-db'" >> .env
  echo "DB_USER = your_database_username" >> .env
  echo "DB_PASSWORD = your_database_password" >> .env
  echo "DB_HOST = 'localhost'" >> .env
  echo "SERVER_PORT = 3000" >> .env
  echo "JWT_SECRET = your_jwt_secret_string" >> .env

Install dependencies

  npm install

Start the server

  npm server.js