Obudynku is an application for checking buildings located in Poland. The opinions available in this application are especially useful for individuals looking to purchase or rent an apartment. Before making a decision, users can check opinions about a specific building.
- Building Evaluation: Get detailed insights about various buildings in Poland.
- User Reviews: Read opinions from other users to make informed decisions.
- Registration: Create account and manage reviews.
- Acoustic maps: Fetching information from government website about noise pollution.
- Internet provider: Fetching information from government website about internet providers.
- Ensure you have Node.js and npm (Node Package Manager) installed. You can check by running:
node -v npm -v - Ensure you have Yarn. Install it globally:
npm install -g yarn
- Clone the Repository
- Install Dependencies Install the required dependencies:
yarn install - Run the Project Once the dependencies are installed, you can run the project using:
yarn start:frontend
#and
yarn start:backend - Access the Application Once the project is running, you can access it by opening your browser and navigating to
http://localhost:3000.
| Variable name | Description | Required |
|---|---|---|
| NEXT_PUBLIC_GA_TRACKING_ID | No | |
| NEXT_PUBLIC_API_URL | Yes |
| Variable name | Description | Required |
|---|---|---|
| JWT_SECRET_KEY | JWT used to sign auth tokens | Yes |
| GOOGLE_STREETVIEW_KEY | Google API key used to fetch streetview photos | No |
| MYSQL_HOST | Host of the mysql server, sqlite will be used if this variable is not present | No |
| MYSQL_PORT | Yes, if MYSQL_HOST present | |
| MYSQL_USERNAME | Yes, if MYSQL_HOST present | |
| MYSQL_PASSWORD | Yes, if MYSQL_HOST present | |
| MYSQL_DATABASE | Yes, if MYSQL_HOST present |
This project is licensed under the GPLv3 License.