Skip to content

Latest commit

 

History

History
106 lines (62 loc) · 3.4 KB

README.md

File metadata and controls

106 lines (62 loc) · 3.4 KB
Raw

Realty Analytica Frontend

This is the frontend of the Realty Analytica application, built with Next.js and designed to interface with the Realty Analytica Backend. It provides a user interface for real estate analytics and data presentation.

Getting Started

These instructions will guide you in getting a copy of the frontend running on your local machine for development and testing purposes.

Prerequisites

What you need to install the software:

  • Node.js (v12 or higher recommended)
  • npm (usually comes with Node.js)
  • Access to the backend server (backend)

Installing

Follow these steps to set up your development environment:

  1. Clone the Repository:

    git clone [https://github.com/piotrsenkow/realtyanalytica.git](https://github.com/piotrsenkow/realtyanalytica.git)
cd frontend

  2. Install Dependencies:

    Install the required packages using npm:

    npm install

  3. Environment Configuration:

    • Set up any necessary environment variables, such as the backend API URL, in a .env.local file in the root of the project.

    • Example of .env.local:

      NEXT_PUBLIC_API_URL=http://localhost:4000/graphql

  4. Running the Development Server:

    Start the development server with:

    npm run dev

    This will start the Next.js application on http://localhost:3000.

  5. Accessing the Application:

    Open your browser and navigate to http://localhost:3000 to view and interact with the application.

    You can start editing the page by modifying pages/index.tsx. The page auto-updates as you edit the file.

    API routes can be accessed on http://localhost:3000/api/hello. This endpoint can be edited in pages/api/hello.ts.

    The pages/api directory is mapped to /api/*. Files in this directory are treated as API routes instead of React pages.

    This project uses next/font to automatically optimize and load Inter, a custom Google Font.

    Learn More

    To learn more about Next.js, take a look at the following resources:

    You can check out the Next.js GitHub repository - your feedback and contributions are welcome!

Running Tests

Provide instructions on how to run any tests that you have set up (if applicable).

Deployment

Include additional notes about how to deploy the frontend application, such as deploying to Vercel, Netlify, or other hosting platforms.

Built With

  • Next.js - The React framework used
  • Tailwind CSS - Styling framework
  • [Other Libraries/Frameworks]

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

License

This project is licensed under the MIT License.

Acknowledgments

  • Hat tip to anyone whose code was used