Jamalyzer

Jamalyzer is a web-based tool for analyzing and evaluating game jams on itch.io. It provides valuable insights and statistics on the game development community by collecting data from various game jams and presenting it in an easy-to-understand format.

Visit the website at https://www.jamalyzer.com

Getting Started

Development

Frontend

1. Clone the repository to your local machine: git clone https://github.com/Fabianofski/Jamalyzer.git
2. Go to the Frontend folder: cd frontend
3. Install the required dependencies: npm install
4. Start the development server: npm run dev
5. Open your browser and navigate to http://localhost:3000 to view the application

Backend

1. Clone the repository to your local machine: git clone https://github.com/Fabianofski/Jamalyzer.git
2. Go to the Backend folder: cd backend
3. Install the required dependencies: npm install
4. Add .env file in Backend folder

   VERSION='0.2'
   NODE_ENV='DEVELOPMENT'
   MONGO_AUTH='root:password'
   MONGO_HOST='localhost:27017'
   REDIS_HOST='localhost'
   REDIS_PORT="6379"
   REDIS_PASSWORD='password'
   

5. You need to have a mongodb running on port 27017 and a redis server running on port 6379 to start the Backend
6. Start the development server: npm start
7. The backend will be running on http://localhost:3001

Docker

1. Add .env file in Backend folder

   VERSION='0.2'
   NODE_ENV='DEVELOPMENT'
   MONGO_AUTH='root:password'
   MONGO_HOST='localhost:27017'
   REDIS_HOST='localhost'
   REDIS_PORT="6379"
   REDIS_PASSWORD='password'
   

2. Add .env in root directory

   REDIS_PASSWORD='password'
   MONGO_PASSWORD='password'
   

3. Run docker compose up -d
4. Open your browser and navigate to http://localhost:3000

Built With

• React - JavaScript library for building user interfaces
• Next13 - React framework for server-side rendering and static site generation
• Node.js - JavaScript runtime for back-end development
• Express - Node.js web application framework
• MongoDB - NoSQL database used to store the data
• Redis - Open source in-memory data structure store

License

Code

This project is licensed under the MIT License - see the LICENSE file for details.

Assets

Unless mentioned otherwise, all art, sound and music assets are distributed under the Creative Commons Attribution-NonCommercial 4.0 International license.