Git Product home page Git Product logo

legalmation's Introduction

LegalMation ReactJS Coding Challenge Documentation

This repository contains the solution for the LegalMation ReactJS Coding Challenge, which demonstrates proficiency in ReactJS, Redux Toolkit, Vite.js, Vitest, and MirageJS.


Project Overview

The LegalMation ReactJS Coding Challenge required the creation of a React application with the following features:

  • Implement CRUD (Create, Read, Update, Delete) operations for at least one resource type.
  • Use Redux Toolkit for state management.
  • Utilize Vite.js as the bundler.
  • Set up MirageJS for mocking a REST API server.

Application Requirements

Author Requirements

  1. Viewing a List of Resources:

    • Users can view a list of resources.
  2. Resource Filtering:

    • Users can filter the list of resources by at least one attribute (implemented by name).
  3. Viewing Resource Details:

    • Clicking on a resource in the list displays detailed information.
  4. Creating a New Resource:

    • Users can create a new resource.
  5. Updating Resource Details:

    • Users can update existing resource details.
  6. Deleting a Resource:

    • Users can delete an existing resource.
  7. Managing Books for Authors:

    • Users can add and remove books associated with each author.
    • Books related to an author can be displayed and managed within the application.

Implementation Status: These user requirements have been implemented as specified in the project. For details, refer to the respective sections of the codebase.


Testing

The project includes tests to ensure comprehensive coverage of its functionality:

  • Test Framework: Vitest is used as the testing framework.
  • Test Coverage: Tests cover components, actions, and reducers.
  • Running Tests: Execute npm test to run tests locally.

Testing Status: The majority of unit tests and integration tests have been implemented to demonstrate proficiency with testing practices. These tests cover key functionalities and ensure that the application behaves as expected.


Project Structure

The project is organized as follows:

  • src/: Source code directory.
  • src/components/: React components.
  • src/dashboard/: Main page.
  • src/theme/: theme setup.
  • src/store/: Redux store configuration, actions, and reducers.
  • src/api/: api setup.
  • src/mirage/server.ts: MirageJS server setup.

Setup Instructions

Follow these steps to set up the project locally:

  1. Clone the repository:
    git clone https://github.com/MarinaKam/legalmation.git
    cd legalmation
  2. Install dependencies: npm install
  3. Start the development server: npm run dev
  4. Open localhost:3000 in your browser.

legalmation's People

Contributors

marinakam avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.