Skip to content

README.md

Latest commit

 

History

History
101 lines (81 loc) · 3.48 KB

README.md

File metadata and controls

101 lines (81 loc) · 3.48 KB

DoorMe: A Web-Based Dormitory Search Platform for College Students

WEB DEVELOPMENT BSCS 3-3

MEMBERS

Installation

Node.js and npm

Before installing the DoorMe Website, ensure you have Node.js and npm installed on your system. Follow these steps to install Node.js and npm:

  1. Download Node.js:

    • Visit nodejs.org and download the latest version of Node.js for your operating system.

  2. Install Node.js:

    • Follow the installation instructions provided by the Node.js website to install Node.js on your system.

  3. Verify Installation:

    • Open a terminal or command prompt.
    • Run the following commands to verify that Node.js and npm are installed: 
      node -v
npm -v
    • If you see version numbers printed for both commands, Node.js and npm are successfully installed.

React and Dependencies

To set up the DoorMe Website locally, follow these steps:

  1. Clone the repository:

    git clone https://github.com/Java-rice/doorme.git
cd doorme

  2. Install dependencies:

    • First, navigate to the project directory (doorme).
    • Run the following command to install React and other necessary packages: 
      npm install react
npm install react-dom
    • If you're starting a new React project from scratch, you can use create-react-app to scaffold the project and automatically install React. Run the following command: 
      npx create-react-app doorme
cd doorme
    • This will create a new React project in the doorme directory and automatically install React and its dependencies.

To set up the DoorMe Website locally, follow these steps:

  1. Clone the repository: 
    git clone https://github.com/Java-rice/doorme.git
cd doorme
  2. Install dependencies:
  • First, ensure you have Node.js and npm installed. Then, install React and other necessary packages: 
    npm install react-transition-group
npm install react-transition-group
npm install react-router-dom
npm install -D tailwindcss
npm install express sqlite3 body-parser cors
npm install axios
npm install clsx
npm install tailwind-merge
npm install class-variance-authority
npm install autoprefixer
npm i --save @fortawesome/fontawesome-svg-core
npm install --save @fortawesome/free-solid-svg-icons
npm install --save @fortawesome/react-fontawesome
npm install @mui/material @emotion/react @emotion/styled
npm install mapbox-gl @mapbox/mapbox-gl-geocoder open-location-code

Usage

To start the development server, run: npm run dev

This will start the React app, and you can view it in your browser at http://localhost:3000.

Technologies Used -HTML: For the structure of the website. -CSS: For styling and layout. -JavaScript: For functionality and interactivity. -React: For building the user interface. -React Router DOM: For routing and navigation.

Contributing We welcome contributions from the community. To contribute, please fork the repository and create a pull request with your changes. Ensure your code adheres to our coding standards and includes proper documentation.

Thank you for being part of the Filo Travel community! Happy travels!