Skip to content

NerdeeApp/Nerdee-Web

Repository files navigation

Nerdee Web App

MUST READ!

Index


TODO

  • Create basic landing page
  • Create multi-page funtionality
  • Link with backend
  • Create useable, responsive CSS
  • Make better documentation

Running the app

Install all packages with yarn
Run yarn start to launch it in a live browser tab
You can now edit pages without needing to reload the tab.

If you close the tab, you can reopen it in localhost:3000


Building for production

Run yarn start to make sure your version is working.
Once the app is working, you can run yarn run build to create an optimised version.
To make the build open, you can run

  • yarn global add serve
  • serve -p 80 -s build

with port 80 being the port accessed from the browser. The default is port 5000
You can then access the local build in localhost:80 or whatever port you chose.


Contributing

Please contribute non-essential features to a new branch with the prefix of feature-(name)
All essential features should have the prefix essential-(name) or urgent-(name)
e.g. an essential security fix is needed, team 1 add it as name essential-bug-fix.
They then open a pull request for the branch to be merged with master.

Do not push directly to master, make a new branch


External Help/Docs

About

The web interface for Nerdee.io

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published