search

HappyPantss / real-time-web-2021

This is the repository for Real-Time Web @cmda-minor-web 2020/2021 @cmda-minor-web. In this project I am making my own Unscramble game where you can play real time (multi-user) with your friends! Unscramble the word first, and get the most points! 💬🥇
https://get-scrambled.herokuapp.com/
MIT License
0 stars 1 forks source link

Generic repo feedback #1

Open bommezijn opened 3 years ago

bommezijn commented 3 years ago

Repo description / about isn't your own yet, how about mentioning it is a real-time scramble that retrieves words from an API?

bommezijn commented 3 years ago

Live demo

I don't see a link to the application yet, if it hasn't been deployed yet; don't forget to put it live soon!

bommezijn commented 3 years ago

Unwanted files

I see that there are node_modules and .env in the repository, this is sad and will take pushing really long or show your secrets.

In GitHub, you can delete the files (but not from the history sadly) and make sure they won't be added anymore in the repo by adding them to the gitignore (node_modules already there).

For the .env, I would suggest pushing a .env.template with the secrets you want people to fill in and mention this in the readme.

bommezijn commented 3 years ago

Missing sections

I don't see a section about the data yet, specifically the data cycle, external API (how it works, how you connect, what you retrieve from it), or the real-time events that are taking place.

The installation section looks good and clear, but it might be an idea to move it upwards, as that is usually what we developers like to see as early as possible. What about placing it under the about section?

HappyPantss commented 3 years ago

Hey Nathan. I like they way you're giving me feedback. It's so organized! Thank you again for letting me these things know, I will work on it as soon as possible!