fair-manager

Welcome to FairManager, an administrative service to handle and manage companies, events, user and much more for your event!

To add new views

See the example folder: https://github.com/apals/FairManager/tree/master/client/app/edit-partner

In order to add a new view in the front-end, do the following

1. Create a folder with the view-name in client/app/

2. In this folder, create 3 files: the .html-file, the .controller.js (with the naming convention) file, and a .js file

3. The .js file should contain the route logic, see for example https://github.com/apals/FairManager/blob/master/client/app/edit-partner/edit-partner.js authenticate: admin also restricts the routes to users with administrator-access. See possible roles in client/app/app.constant.js

4. If you want to add this to the navbar in the top, find navbar.controller.js in client/components/navbar and add it to the menu-list. If you want to add to the right-hand side of the navbar, add it in the navbar.html file.

what the generator did and what it didn't

An example project generated with the generator can be found here: https://github.com/DaftMonk/fullstack-demo

• The generator generated an example project for us, with some functionality.

• We did not implement authentication logic ourselves, seeing as that's pretty frowned upon generally. Chances are we'd implement security badly and/or incorrectly.

• The navbar came with the generator.

• The view that was generated for us was only a list of strings. These strings were synced between clients through sockets, so we used that example code to help us create our own client synchronization.

• Everything else was built by us. That means every edit-view, every view where you add new entries, every detail view, etc.

Addressing critique

• A LOT OF FILES, we have many files in the root of the project for many different reasons, including

  • .jscrc, .editorconfig - for maintaining consistent coding styles in the project
  • karma.conf.js, mocha.conf.js, protractor.conf.js - for configuring test environments
  • .travis.yml - for continous integration and automatic deploy
  • Procfile - declaring how Heroku should start our application from the project root
  • Gruntfile - configuration file for building the project
  • e2e folder - contains end-to-end tests
  • iOS - contains iOS application
  • website - contains code for http://alsing.me/fairmanager

• In client/app folder we have one folder for every view, and a folder for angular services.

• The overview-directive (https://github.com/apals/FairManager/tree/master/client/app/overview) eliminates code-duplication from the lists (e.g. in /companies, /events etc). However, when adding new items eg. events, exhibitors, we need similar code in different places because they have different inputs. E.g. an event has date-input fields, whereas an exhibitor has multiple image-upload fields etc.

Clarification is required. Files are not structured well, however, code are divided well but a lot of code repetition exist, hence request of clarification.

Screenshots

Splash screen

Events

Exhibitors

Personnel

Partners

Chat

Generating tool

The projects folder structure, the client-side testing suite and the authentication process was generated with the Angular Full-Stack Generator, version 3.3.0.

Getting Started

Prerequisites

• Git
• Node.js and npm (Node v4.2.3 or higher and npm v2.14.7 or higher)
• Bower (npm install --global bower)
• Ruby (Ruby v2.2.2 or higher)
• Sass (gem install sass)
• Grunt (npm install --global grunt-cli)
• MongoDB - In case you want to test integrations, keep a running daemon with mongod

Developing

1. Clone the repository using git clone git@github.com:apals/FairManager.git and enter the directory where it was cloned.

2. Run npm install to install server dependencies.

3. Run bower install to install front-end dependencies.

4. Run mongod in a separate shell to keep an instance of the MongoDB Daemon running

5. Run grunt serve to start the development server. It should automatically open the client in your browser when ready.

Build & development

Run grunt build for building and grunt serve for preview.

Testing

• Running npm test will run the unit tests with karma.
• Running grunt mochaTest will run the remaining integration and unit tests with karma.