https://github.com/idraynar/note4iim

This project is a interne solution for our school, it will help the students to share lessons with the others.
https://github.com/idraynar/note4iim

back-end front-end nextjs supabase

Last synced: about 1 month ago
JSON representation

This project is a interne solution for our school, it will help the students to share lessons with the others.

• Host: GitHub
• URL: https://github.com/idraynar/note4iim
• Owner: IDRAYNAR
• License: mit
• Created: 2023-12-18T13:11:22.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2024-02-15T15:33:49.000Z (11 months ago)
• Last Synced: 2024-03-29T23:37:01.894Z (9 months ago)
• Topics: back-end, front-end, nextjs, supabase
• Language: JavaScript
• Homepage: https://note4-iim-coral.vercel.app/
• Size: 909 KB
• Stars: 2
• Watchers: 2
• Forks: 0
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Note4IIM : A note taking app for IIM students

[![GitHub tag](https://img.shields.io/github/tag/IDRAYNAR/Note4IIM?include_prereleases=&sort=semver&color=blue)](https://github.com/IDRAYNAR/Note4IIM/releases/)

[![License](https://img.shields.io/badge/License-MIT-blue)](#license)

[![issues - Note4IIM](https://img.shields.io/github/issues/IDRAYNAR/Note4IIM)](https://github.com/IDRAYNAR/Note4IIM/issues)

[![stars - Note4IIM](https://img.shields.io/github/stars/IDRAYNAR/Note4IIM?style=social)](https://github.com/IDRAYNAR/Note4IIM)

## Overview

This is a full-stack web application built with Create React App for the frontend and Strapi for the backend. The frontend code is located in the Frontend directory, and the backend code is located in the Backend directory.

## Getting Started

To launch the project:

1. **Frontend**:

   - Access the Frontend directory `cd Frontend`.

   - Run `npm install` to install dependencies.

   - Run `npm start` to start the development server.

2. **Backend**:

   - Access the Backend directory `cd Backend`.

   - Run `npm install` to install dependencies.

   - Run `npm run develop` to start the Strapi application with autoReload enabled.

## Environment Variables

- For the backend, set environment variables in a `.env` file in the Backend directory, look at the file `.env.example` for an example.

## Additional Information

- The project uses Supabase, Axios, and React Router for the frontend.

- The backend uses Strapi with plugins for cloud, internationalization, and user permissions.

For more detailed information, please refer to the project's codebase.

### Tips and Commands

- To install frontend dependencies: `npm install` in the Frontend directory.

- To start the frontend development server: `npm run start` in the Frontend directory.

- To install backend dependencies: `npm install` in the Backend directory.

- To start the Strapi application with autoReload enabled: `npm run develop` in the Backend directory.

### Explanation

This project follows a microservices architecture with a separate frontend and backend. The frontend is built using Create React App and utilizes Supabase, Axios, and React Router. The backend is powered by Strapi and includes plugins for cloud storage, internationalization, and user permissions.

### Team

- [Alexischochinafcinq](https://github.com/alexischochinafcinq)

- [DricSun](https://github.com/DricSun)

- [EstebanQui](https://github.com/EstebanQui)

### Collaboration

This project is open to collaboration. If you would like to contribute, please fork the repository and submit a pull request.

### License

This project is licensed under the MIT License. See the LICENSE file for more information.