Project requirements

Project requirements version 1.0

Services used:

• Visual studio code: Company code editor.
• PHP server: Company server.
• Contentful: used for hosting content and markdown. Remember to hide the API keys.
• Adobe: Used to create designs and mockups.
• Figma: Used to create designs and mockups.

Website requirements:

• Website text is (almost) fully imported from Contentful

• Being able to translate text to:

  • English (Main)
  • Japanese
  • Korean
  • Chinese
  • Spanish
  • French
  • Dutch
  
  

  Use locales and databases for translations.

• Visitors are able to use payment services.

• The website is able to be used on all 5 categories of device viewports, fully responsive.

Features:

• Route planner: You can find the route between two points using a special build widget with options for time planning and accesibility. Make it able to be included inside a Contentful article.

• Auto generated articles: Make the website able to generate new pages dynamically by just adding and editing Contentful articles. Be sure to include code to prevent overwriting existing pages.

• Articles about travel information, usage of our services, helpful articles, travel suggestions, ideas, and more. We will keep you posted on the specific list when needed.

• A online shop to buy Shunji Railways themed articles, including payment services.

• A interactive map of the Globalpolis valley area. You can zoom in and such, and find hotspots and our stations. Later on you we can add more maps.

• A contact page with an e-mail service to send e-mails to us.

• A scroller on the homepage with news and announcements.

• Image button tiles to featured articles and pages.

• A mega menu for navigation, auto generated using info about the Contentful page list.

Design

• Theme: Sleek modern, sci fi, playful.
• Colors:
  • White.
  • Light cold grey.
  • Black.
  • Bright leave green (Shunji green).
• Design elements:
  • 3D effects like shadows.
  • Playful animations.
  • Sleek thin colored lines.
  • Lots of icons.
  • Playful art and characters.

Code requirements

• Follows the contribution guidelines, all styleguides and coding principles listed on the GitHub page.
• Sensitive information is hidden from public, like our Contentful API keys.
• Content is separate from the functional code.

Authors

• Shunji Railways™ local branch office Leeuwarden, the Netherlands.
• The Shunji Railways Group™, a Global Union™ daughter branch.