Skip to content

Latest commit

 

History

History
107 lines (69 loc) · 2.61 KB

README.md

File metadata and controls

107 lines (69 loc) · 2.61 KB
Raw

Chibueze Lema AI

This project is a web application built with a React-based frontend and a Node.js backend. It provides an API for managing users and demonstrates modern web development practices with a focus on TypeScript and best practices for both frontend and backend development.

Live Application

API Endpoint

Test the backend for the Users API:

GitHub Repository

Find the source code here:

Installation

To set up the application locally:

Frontend

  1. Navigate into the `frontend` directory: ``` cd frontend ```
  2. Install dependencies: ``` npm install ```
  3. Start the development server: ``` npm run dev ```

Backend

  1. Navigate into the `backend` directory: ``` cd backend ```
  2. Start the server: ``` npm run dev ```

Technologies Used

Frontend

  1. React: For building the user interface.
  2. Vite: As the build tool for fast development.
  3. React Hook Form: For managing form state and validation.
  4. Joi: For schema validation.
  5. Cypress & Vitest: For testing.
  6. TypeScript: For type safety and better developer experience.

Backend

  1. Node.js: For building the server-side application.
  2. TypeScript: For type safety and maintainability.
  3. SQLite: As the database.
  4. sqlite3: For interacting with SQLite.

Deployment

  • Frontend: Hosted on Vercel for fast and reliable deployment.
  • Backend: Hosted on Render for server-side hosting.

Database Information

  • SQLite is used as the database.
  • No migration is required, as the database structure has not been altered.

Testing

  • Frontend Testing: Cypress and Vitest are used for component and end-to-end tests.
  • Backend Testing: The backend API is tested via tools like Postman or other API testing frameworks.

Author

Chibueze Sam-Obisike

Feedback and Contributions

Feel free to submit issues or contribute to the project via the GitHub repository.