MERN-Estate

This is a course project, in which I will build a fullstack web application

Table of Contents

• Project Structure
• Features
• Prerequisites
• Installation
• Running the Application
• Scripts
• Contributing
• License

Project Structure

The project is structured into two main directories:

1. Client: Contains the front-end code.
2. Server: Contains the back-end code.

Features

• Client: Built with React and TypeScript, it provides a responsive and interactive user interface.
• Server: Developed with Node.js, Express, and MongoDB, it offers a robust and scalable back-end.

Prerequisites

Before you begin, ensure you have met the following requirements:

• Node.js and npm installed on your machine.
• MongoDB installed and running.

Installation

Follow these steps to install the project:

Clone the Repository

git clone https://github.com/your-username/your-repo-name.git
cd your-repo-name

cd client
npm install

cd ../server
npm install

Client Scripts

npm start: Starts the development server.
npm build: Builds the app for production.

Server Scripts

npm start: Starts the server.
npm run dev: Starts the server in development mode with nodemon.

Contributing

To contribute to this project, follow these steps:

Fork this repository.
Create a branch: git checkout -b feature/your-feature.
Make your changes and commit them: git commit -m 'Add some feature'.
Push to the original branch: git push origin feature/your-feature.
Create the pull request.