Skip to content
This repository has been archived by the owner on Dec 20, 2023. It is now read-only.

SU-CS308-22FA/Team_09_Scoutff

Repository files navigation

This is an image

Scoutff

Scoutff is a web application that provides various Turkish Super League related leaderboards and custom squads to its users. It aims to increase the popularity of the league among fans and discover young talents. It has been developed in Next.js v12.2 environment with ReactJS v18, NodeJS v18, MongoDB and ChakraUI.

Table of Contents

User Documentation

Installing the Software

No installation is required. You can just click on the link: https://scoutff.vercel.app

Reporting bugs

To report a bug, navigate to 'Help' page on the website and fill the complaint form.

Known bugs

If the user stays idle in any page for longer periods than 30 minutes, user token expires and database calls do not work.

Develeoper Documentation

Obtaining the source code

Cloning the repository is enough to obtain the source codes, since both backend and frontend are available here.

Layout of the directory and branching

Layout

  • adapters
    • Includes Nextout verification with database for login and register actions.
  • components
    • Includes necessary react components and functions, and ChakraUI definitions.
  • lib
    • Handles general MongoDB connection where /api handles post requests from database.
  • models
    • Configurations for different types of namespaces in database
  • pages
    • Includes the frontend spesifications of all the possible pages.
    • api
      • Handles backend related authentiaction and api operations.

Branching

  • main
    The main branch which includes the deployed content.
  • v3
    The experimental branch where features are examined before committing to main branch.

Building and deploying

  1. Clone the repository
  2. For local uses, utilize the main branch.
  3. Run the following command: npm install
  4. Depending on your approach;
    • For development, run: npm dev
    • For production, run: npm build + npm start

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •  

Languages