Code Monkey home page Code Monkey logo

comp-333-3-frontend's Introduction

Frontend README

This README provides information on the frontend part of our project for COMP 333: Software Engineering 2023 at Wesleyan University. The project is developed by @n-aggarwal and @ananafrida.

Project Overview

In this assignment, we have developed a full-stack CRUD (Create, Read, Update, Delete) app with a React frontend that seamlessly integrates with our PHP/MySQL backend via a REST API. The app allows users to manage a list of songs, including creating, reading, updating, and deleting songs. The frontend provides a user-friendly interface to interact with the database.

Learning Goals Achieved

In this project, we have achieved the following learning goals:

  1. Designed and implemented a single-page app (SPA) using JavaScript and React.
  2. Utilized the Model-View-Controller (MVC) design pattern to create a Representational State Transfer (REST) API for frontend-backend communication.
  3. Gained experience with build tools, package managers, and integrating third-party code.

Setup and Run the Frontend

Follow the instructions below to set up and run the frontend of our app in a local development environment.

  1. Clone the Repository: Clone this repository to your local machine:

    git clone https://github.com/your-username/frontend-repo.git
  2. Navigate to the Frontend Directory: cd frontend-repo

  3. Install Dependencies: Install the required dependencies using npm: npm install 4 Run the Development Server: Start the development server for the frontend: npm start

  4. Accessing the app Open a web browser and access the app at http://localhost:3000

MVC Architecture and REST API

Our app follows the Model-View-Controller (MVC) design pattern, which separates the software's business logic, display, and controlling logic.

  • Model: Manages data and business logic (e.g., SongModel.js, UserModel.js).
  • View: Handles layout and display (e.g., React components).
  • Controller: Routes commands to the model and view (REST API via index.php).

Backend Repository

For details on the backend and how to set up the database, refer to the Backend README.

Feature Implementation

In addition to the required CRUD operations, we have implemented the following feature:

  • Filter functionality.

comp-333-3-frontend's People

Contributors

ananafrida avatar n-aggarwal 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.