Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/roodbaraky/examgenie-fe
ExamGenie is a study tool designed to help students practice past papers built with **React + Vite**, **TypeScript**, **Node.JS**.
https://github.com/roodbaraky/examgenie-fe
nodejs postgresql react supabase typescript vite
Last synced: about 1 month ago
JSON representation
ExamGenie is a study tool designed to help students practice past papers built with **React + Vite**, **TypeScript**, **Node.JS**.
- Host: GitHub
- URL: https://github.com/roodbaraky/examgenie-fe
- Owner: Roodbaraky
- Created: 2024-08-06T19:12:17.000Z (6 months ago)
- Default Branch: main
- Last Pushed: 2024-11-27T20:40:43.000Z (2 months ago)
- Last Synced: 2024-12-30T01:53:26.516Z (about 1 month ago)
- Topics: nodejs, postgresql, react, supabase, typescript, vite
- Language: TypeScript
- Homepage:
- Size: 208 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# ExamGenie
ExamGenie is a study tool designed to help students practice past papers efficiently and effectively. This repository contains the source code for the frontend application, built with **React + Vite**, **TypeScript**, **Node.JS**.
## Table of Contents
- [ExamGenie](#examgenie)
- [Table of Contents](#table-of-contents)
- [Features](#features)
- [Technologies Used](#technologies-used)
- [Installation](#installation)
- [Usage](#usage)
## Features
- **User Authentication**: Secure sign-up and login functionality.
- **Search and Filter**: Easily search and filter past papers by tag and difficulty level.
- **Upload Questions**: Upload new question and answer sets to query with the search tool.
## Technologies Used
- **React**: A JavaScript library for building user interfaces.
- **React Router**: Declarative routing for React applications.
- **Axios**: Promise-based HTTP client for the browser and Node.js.
- **Tailwind CSS**: A utility-first CSS framework for rapid UI development.
- **Vitest**: JavaScript Testing Framework.
## Installation
To get started with the development, clone this repository and install the necessary dependencies.
1. Clone the repository:
```bash
git clone https://github.com/Roodbaraky/ExamGenie-fe
```
2. Navigate to the project directory:
```bash
cd ExamGenie-fe
```
3. Install the dependencies:
```bash
npm install
```
## Usage
To start the development server, run:
```bash
npm run dev
```
This will start the application in development mode. Open http://localhost:3000 to view it in the browser.
To build the project for production, run:
```bash
npm run build
```
This will create an optimized build of the application in the build directory.