Agricola online game - Backend Repository

Environment

Stack

Communication

---

Index

Repository Structure / How To Start / Contributor / How To Contribute

---

Repository Structure

.
├── README.md
├── app.js
├── config # Some configs for project
│   ├── baseResponseStatus.js
│   ├── config.js
│   ├── response.js
│   └── secretKey.js
├── controllers # Controller which get requests from frontend
│   ├── actionSocketController.js
│   ├── gameSocketController.js
│   ├── roomController.js
│   ├── roomSocketController.js
│   └── userController.js
├── middlewares # For middlewares - In this case, for Sign up/in
│   └── auth.js
├── migrations # Migration files for backup using sequelize
│   ├── 20230514164610-Users.js
│   ├── 20230515074818-game_room.js
│   └── 20230517152458-UserGameRoom.js
├── models // Data models
│   ├── Card.js
│   ├── GameRoom.js
│   ├── GameStatus.js
│   ├── User.js
│   ├── UserGameRoom.js
│   └── index.js
├── modules # Files and modules which are used entire project
│   ├── jwt.js
│   └── utility.js
├── package-lock.json
├── package.json
├── pr_checklist.md
├── readme_src
│   └── agricola.gif
├── routes
│   ├── roomRoute.js
│   └── userRoute.js
├── services # Files where entire service logics in
│   ├── gameService.js
│   ├── roomService.js
│   └── userService.js
└── test # Files for unit test
    └── test.js

How To Start

Prerequiste:

1. installation of node, the versions must be 16 or later for reliable execution
2. Two files below should be located in the certain location

• .env: In the top level, same level with .gitignore file
• secretKey.js: Under the config folder, same level with config.js file
  

You can get the files on our notion page! https://www.notion.so/2c5644b064b14677bbedb58f07341afe?pvs=4

※WARNNING※: If there is a database connection error when running this project, there may be problem with Wi-Fi. Change the Wi-Fi.

# Install dependencies required to run project
$ npm install

# Run the app
$ node app.js

Contributor

	name	main task	github address	contact
	Gayeon Bae	Backend Developer	https://github.com/BaeGayeon	[email protected]
	Minjae Kim	Backend Developer	https://github.com/Minjae-vincent	[email protected]

How to contribute

If you have a suggestion that would make this better, please fork the repo and create a pull request.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request