Skip to content

Latest commit

 

History

History
62 lines (43 loc) · 5.73 KB

README.md

File metadata and controls

62 lines (43 loc) · 5.73 KB

Wave Research Server ✨

Wave Research: No. 1 free online football manager for advanced soccer management. The title of manager is almost exclusively used in British football. In most other European countries in which professional football is played, the person responsible for the direction of a team is awarded the position of coach or "trainer"
This app was built to meet a true soccer management system where the developers and contributors also play the game.
I've always had the goal to build a free online soccer app that can compete with PES and eFootball, but then what really pushed/motivated me to start the development of Wave Research, was a question asked on another football manager platform, and the user goes like this 'Does the developers of this game even play it or knows what it looks like?'
Initially, Wave Research was a closed source app, but my mentor who's a lover of Open Source Community influnced my decision to make it public; such that it will really benefit the software developers community, in a way that new developers and experienced developers can fork the project, tweak it and experiment new features with it.
That being said PERMISSION IN NOT GRANTED TO CLONE THIS APP FOR ANY COMMERCIAL GAIN IN ANY FORM NOR DEVATE FROM IT'S ORIGINAL PURPOSE, NEITHER IS ANYONE ALLOWED TO USE PART/FULL CODEBASE ON ANOTHER PLATFORM WITHOUT EXPLICIT AUTHORISATION FROM ME

About Wave Research Server

Wave Research Server holds the code neccessary for the backend of Wave Research, which is an online Soccer Manager App with the main of building an engaging online soccer game with peoples satisfaction as our goal. What motivated me to build Wave Research was the inability for existing Online Manger games to give what we really want in a soccer manager app, after sending mails most platform on how to improve the game, without response, i can accross one post where a user asked 'Do the developers of this game even play it, or are they just there for money'.

Wave Research APIs are hosted on Render. Though similar in nature, they handlle different api request: console | accounts | manager | apihub

API Action
console Handles admin/moderators actions such as logs, contact us, etc.
accounts Handles actions such as signin, signup, password reset, data eletion, etc.
manager handles all soccer manager related endpoints
apihub handles all public apihub related endpoints

NPM Packages && Services

All packages installed are key to this app running smoothly and we graciously thank the group of developers maintaining those packages. Currently our server is running on a free tier hosted on RENDER formerly on Heroku before it's free plan was cancelled and we are working on raisng funds to upgrade our server. The following in no particular order executes a very important task on our server.

  1. https://kaffeine.herokuapp.com: Since we run our app on a free tier, Kaffeine helps to keep our app awake 24hrs.

  2. Having our app awake 24hrs, we use node-cron to keep our Tasks up and running which is crucial to the game. such as generating match scores, automatically accepting and sending bids from unmanaged clubs, injuries and fitness, etc.

  3. We would be considered greedy and selfish if we fail to mention MongoDB, what is game without a database, and not just a database, a powerful NoSQL Database.

Authors

To learn more about this project, kindly contact the developer 😎 ChukwuEmeka Maduekwe:

💰 Support Me 👋

Buy Me A Coffee

Getting Started

  1. Fork Wave Research Server [here](https://github.com/Chukwu3meka/Wave Research-Server.git)
  2. Now clone your remote branch, and run npm install or npm i for short; to install all packages
  3. If you don't have a gitignore file, create one and run git rm -r --cached . to ensure git is tracking the right file, i.e files not listed in the new .gitignore
  4. In development we run a few command to reflect changes on file change, and to keep our app running all the time

    npm run tsc: to compile our typescript files in the source folder npm run dev: to start our development server in the dist folder

  5. You don't need to install any project management such as nodemnon or pm2 as Node.js 18 now comes witth and inbuilt watch mode
  6. Make sure to use node as enviroment, yarn as build command and npm start to start app in render
  7. ...

Issues

  1. Stick to Passport 0.5 to avoid issues with oauth for now. stackoverflow
  2. Ensure not to add NODE_ENV = "development" to server env, to allow installation of dev dependencies
  3. before email update, send notification consistently for 7 days beforeemail change can take effect, also display it in app/user profile pae that email has been updated and will take effect in 7 days time
  4. Make sure to set case sensitivity in folder/file rename on git/windows
  5. most website sanitize empty space in password