update readme - Githubissues

SparkEdUAB / sparked-client

SparkEd V3

https://sparked.netlify.com

MIT License

5 stars 4 forks source link

update readme #24

Closed OlivierJM closed 5 years ago

OlivierJM commented 5 years ago

Add more information in the readme to reflect instructions and other related information

OlivierJM commented 5 years ago

a good example would be what is here https://github.com/SparkEdUAB/sparked-server

OlivierJM commented 5 years ago

What is needed in the readme

[x] Summary of the project, can be found here
[x] What's required to run the project and the tech stack used
[x] Instructions on how to run the project
[x] Contributing guide
[x] Code of Conduct

wilfredmulenga commented 5 years ago

we might need to update this one soon to let other possible contributors be able to run the project. I am guessing the SparkEd client needs the SparkEd server to run?

OlivierJM commented 5 years ago

Yeahh very true, I might jump on it tomorrow morning

OlivierJM commented 5 years ago

If its of interest to add to the readme the current looks of the minimal dashboard Screenshot 2019-10-06 at 12 40 02 AM

OlivierJM commented 5 years ago

I have added the basics in the readme, I think I will close this issue soon if there isn't update.