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.
To run this project locally, you need to have the following installed on your machine:
-
PHP (version 7.2 or higher)
- You can download PHP from php.net.
-
Composer
- Composer is a dependency manager for PHP. You can download it from getcomposer.org.
-
Node.js (version 14 or higher)
- You can download Node.js from nodejs.org.
-
npm (comes with Node.js)
- npm is the package manager for JavaScript.
Follow these steps to set up and run the project locally:
Open your terminal and run the following command to clone the repository:
git clone https://github.com/loveCiForever/note-mana.gitcd note-mana-
Navigate to the Backend Directory
cd server -
Install Backend Dependencies
Run the following command to install the required PHP packages using Composer:
composer install
-
Set Up Environment Variables
Create a
.envfile in the backend directory. You can copy the.env.examplefile if it exists:cp .env.example .env
Update the
.envfile with your database credentials and other environment-specific settings. -
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
-
Run the Development Server Start the Slim development server:
php -S localhost:8000 index.php
-
Navigate to the Frontend Directory
cd ../client -
Install Frontend Dependencies
Run the following command to install the required JavaScript packages using npm:
npm install
-
Run the Development Server
Start the Vite development server:
npm run dev
- Open your web browser and navigate to
http://localhost:3000to see the React frontend. - The backend API will be accessible at
http://localhost:8000.
- Backend: Slim Framework, PHP, MySQL
- Frontend: React, Tailwind CSS, Axios