siite

The Quodl website - where the latest information on Quodl, the science behind it and sign up links can be found.

Set up

1. Clone this repo onto your machine

git clone [email protected]:cul-2016/site.git
cd site

2. Check you have MongoDB by doing mongo --version, otherwise install it. If you use Homebrew you can do that by doing brew install mongodb or if you use npm you can follow the instructions here: https://www.npmjs.com/package/mongodb.
3. Run npm install in your command line
4. Add the environment variable to connect with our hosted database to your .env file. Ask us and we will provide this for you. The project has got a local database that it can run with if you don't have the .env variable but you will have to start from scratch to fill it with content.
5. Then set the environment variable by doing source .env in your command line.
6. Then do npm start and go to http://0.0.0.0:3000/
7. To see the admin view go to http://0.0.0.0:3000/login and enter a username and password (provided by us).

Guide for site admins

To log in as as an admin go to: http://quodl-site.herokuapp.com/login and enter your username and password. If you do not yet have a username and password ask another admin to set up an account for you.

Once you have logged in you should be able to see two menus on every page:

Clicking on either menu opens up their options. The 'A' menu has the same options across all pages, whereas the options of the page menu change according to which page you are on.

The 'A' menu is an overview of all of a given thing over the site ie. users, messages sent by the contact form, blog articles etc. Clicking on each category opens up information about that thing ie. users and gives you the ability to change them.

Admins shouldn't need to change much using the page menu. It is powerful and capable of deleting and creating new pages which you do not want to do accidentally. There are two main cases in which you may wish to use this menu:

1. If you made a change to a page and want to see what the page looked like previously. To do this click on 'Page Versions':

Here you can see recent changes to the page and revert back to them if needs be. Note: be careful and pay attention when reverting changes.

2. If you want to create a new blog post. Start on the main blog page and click the menu, you will see the option to create a new article:

Then fill in the fields in the three tabs.

The term 'slug' is part of the url that will appear in the top of the browser, so there must not be any spaces in it. The slug will be automatically generated using your blog title and so you don't need to change it if you don't wish. A long, descriptive slug is fine as it's good for SEO.

For your blog to appear in the 'For Students' or 'For Lecturers' pages make sure you give it either the 'students' or 'lecturers' tag in the 'meta' tab when you create it. You can always change/ update this by clicking on 'Update Article' in the page menu on an article that's already been created. All blog articles will appear under 'All Articles' whether they have any tags or not. Articles can also have more than one tag if you see it relevant.

You must change published to 'yes' if you want the post to be visible on the site.

Once you've completed this section by clicking 'Save Article' you will be taken to your new blog article which will look something like this:

To add content click on the plus icon and choose whether to add text or an image. You can add more than one thing to your blog so once you've added one, look for the plus icon above or below what you just added and you can add something else.

Editing content

A lot of the content on the site is editable but not all of it. To see if a piece of text is editable, when you're logged in as an admin try double clicking on the field. If it is editable you will see a dotted box appear around it:

Then click on the text and you can edit it.

You may also notice these symbols showing when you move around the site:

They are also a sign that something is editable. Ignore the arrow icon, it is not in use at the moment and so won't do anything. Rather than deleting something by clicking the trash can icon, try double clicking the content to get the dotted box. If you do accidentally click the trash icon and you want to recreate what you deleted look where it used to be for something like this:

Click on that and then enter in the text that was there before. You should not need to delete the field and add it again, normally just double click it to see the dotted box.