Skip to content

updated readme file #27

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Bmirz wants to merge 1 commit into
base: main
Choose a base branch
from
Open

updated readme file #27

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 25 additions & 15 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,15 @@ This project is a recipe-sharing web application designed to allow users to crea
- As a user I want to rate recipes.
- As a user I want to see the recipes of other users.

## Technologies Used:
- C#
- Docker (Local)
- Sql Server
- Entity Framework
- REST
- React (Next.js)
- ASP.NET Core Web API

## Running the application:
### Backend
The backend application is a .NET Core code-first application with MS SQL Server as the database server. In order to run the backend application data migration is required.
Expand All @@ -24,22 +33,23 @@ The backend application is a .NET Core code-first application with MS SQL Server
- The MS SQL Server should be running.
- The connection string in `src/Web/API/appsettings.json` should be valid.
- For fresh migrations, delete the `Migrations` folder in `src/Web/API`.
- For fresh database updates, nuke the database using SQL above.
- For fresh database updates, nuke the database using SQL code below.

#### Nuking the SQL Server Database (Database name is ByteShare in example):
```sql
USE [master]
GO
ALTER DATABASE [ByteShare] SET SINGLE_USER WITH ROLLBACK IMMEDIATE
GO
USE [master]
GO
DROP DATABASE [ByteShare]
GO
```

### Frontend
The frontend application is build using React Nextjs.
- To run it navigate to `src/Web/ClientAppAPI` then run the command:
- `npm dev`
- `npm run dev`
- Note:
- Run command `npm install` to install dependencies.

## Nuking a SQL Server Database (Database name is ByteShare in example):
```sql
USE [master]
GO
ALTER DATABASE [ByteShare] SET SINGLE_USER WITH ROLLBACK IMMEDIATE
GO
USE [master]
GO
DROP DATABASE [ByteShare]
GO
```
- Run command `npm install` to install dependencies.