ESNFranceG33kTeam / Universe

This application will gather all ESN resources in one single location.

Universe

This application is meant to be used by ESNers all over the world ! It will enable them to gather all web resources they want in one single location, and to be notified if new content appears on those resources.

• For developpers
  • Install Electron
  • Run the application
  • Open the developer tools
  • Package the application
  • Generate an installer
• For users
  • Install Universe
  • Use Universe
• Patch notes (Old)

---

For developers

Install Electron

Before installing Electron, you must have NodeJS installed on your computer with npm, its packet manager.

To install Electron, use npm like this:

# Install the `electron` command globally in your $PATH
npm install electron -g

# Install all project dependencies
cd universe/ && npm install

Run the application

To launch the application, get into the application directory and launch Electron:

electron .

Open the Developer Tools

If you want to open the dev tools inside the application, you just have to type in the Konami code :)

Package the application

OS	Command
Windows	npm run package-windows
Mac	npm run package-mac
Linux	npm run package-linux

Generate an installer

OS	Command
Windows	npm run create-windows-installer

---

For users

Install Universe!

To install the application, you need to download a version of it that has been compiled for your operating system (Windows, Mac or Linux), and execute it.

Get an installer over there : http://remyraes.com:5014/

Use Universe!

Using the application is pretty easy, if you know all shortcuts ; you can find some tips below:

• to subscribe to a new website, you just have to click the '+' button at the bottom of the sidebar;
• to remove a website you added before, just right-click on its icon in the sidebar, and then click the delete button associated.

---

Patch Notes

For the development of Universe, we use the semantic versioning.

These patch notes only cover patches up to 0.2.1. For later patches, please check the releases system.

• [0.x.x] DEVELOPMENT VERSION
  • [0.2.1]
    • Signals system reviewed: naviguation enhanced
    • Addition of the sites titles
    • Addition of the sites favicons
  • [0.2.0]
    • Addition of the internationalization (i18n)
  • [0.1.1]
    • You can now remove a website you added previously
    • Little code improvements for performance
  • [0.1.0]
    • You can now add a new website to your application !
    • Switching from iframes to webviews, to avoid x-frame-origin errors
  • [0.0.1]
    • Addition of the settings system
    • Addition of the notification system
    • All code has been documented
  • [0.0.0]
    • Introduction of the architecture main wrapper/side menu
    • Usage of iframes
    • Tooltips