Notes backend

This repository contains the backend developed from part 3 onwards in the Full Stack course. The different stages of the application are saved in different branches.

The Notes backend implements a RESTful HTTP interface and handles the management of notes. It is developed using Node and Express. The purpose is to develop a backend that works with the frontend developed in part 2 of the course.

Running the application on your own machine

You can easily try out the application on your own machine. The current version of the application is developed using Node version 22.3.0. For the best experience, it is recommended to use the same major version of Node, but the application will likely work with other Node versions as well.

Follow these steps to run the application:

1. Clone this repository to your own machine with the command git clone https://github.com/fullstack-hy2020/part3-notes-backend.git

2. Navigate to the cloned repository with the command cd part3-notes-backend

3. Switch to the desired branch with the command git switch <branch-name>

4. Install the node modules with the command npm install

5. If you are on branch part3-4 or later, you need to create a .env file in the root of the project with the following content:

   MONGODB_URI=your_database_connection_string
   PORT=3001
   

   MONGODB_URI defines the database connection url and PORT defines the port on which the application will be started.

6. Start the application with the command npm run dev. By default, the application will start on port 3001, so it will be available at http://localhost:3001/.

How to switch between branches?

The different stages of the application are saved in different branches. Switching branches changes the code in your working directory to match the state of the branch you switched to. This allows you to work on different versions of the application without affecting the codebase of other branches.

You can switch to the desired branch by running the command git switch <branch-name>, for example git switch part3-2. Note that new dependencies are added to the application as development progresses, so after switching branches, it is safest to run the command npm install to ensure that any missing node modules will be installed on your machine.