Thanks to visit codestin.com
Credit goes to github.com

Skip to content

VictorNguyenLPN/notema

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

1 Commit
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Notema

Notema is a web application that allows users to manage their notes efficiently. This project consists of a Slim Framework backend and a React frontend styled with Tailwind CSS.

Table of Contents

Requirements

To run this project locally, you need to have the following installed on your machine:

Backend (Slim Framework)

  1. PHP (version 7.2 or higher)

    • You can download PHP from php.net.
  2. Composer

    • Composer is a dependency manager for PHP. You can download it from getcomposer.org.

Frontend (React)

  1. Node.js (version 14 or higher)

  2. npm (comes with Node.js)

    • npm is the package manager for JavaScript.

Installation

Follow these steps to set up and run the project locally:

Clone the Repository

Open your terminal and run the following command to clone the repository:

git clone https://github.com/loveCiForever/note-mana.git

Navigate to the Project Directory

cd note-mana

Backend Setup

  1. Navigate to the Backend Directory

    cd server
  2. Install Backend Dependencies

    Run the following command to install the required PHP packages using Composer:

    composer install
  3. Set Up Environment Variables

    Create a .env file in the backend directory. You can copy the .env.example file if it exists:

    cp .env.example .env

    Update the .env file with your database credentials and other environment-specific settings.

  4. Run Database Migrations (if applicable)

    If your project uses a database and has migrations, run the following command to set up the database schema:

    php artisan migrate
  5. Run the Development Server Start the Slim development server:

    php -S localhost:8000 index.php

Frontend Setup

  1. Navigate to the Frontend Directory

    cd ../client
  2. Install Frontend Dependencies

    Run the following command to install the required JavaScript packages using npm:

    npm install
  3. Run the Development Server

    Start the Vite development server:

    npm run dev

Access the Application

  • Open your web browser and navigate to http://localhost:3000 to see the React frontend.
  • The backend API will be accessible at http://localhost:8000.

Technologies Used

  • Backend: Slim Framework, PHP, MySQL
  • Frontend: React, Tailwind CSS, Axios

Live demo

About

A web application that allows users to manage their notes efficiently

Topics

Resources

Stars

Watchers

Forks

Languages