Skip to content
Permalink
master
Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?

oldenglishonline/README.md

Go to file
 
 
Cannot retrieve contributors at this time
Old English Online About Table Of Contents Contributor's Guide How do I submit a good bug report? How do I submit a good feature request? Developer's Guide Installing and Running License
executable file 73 lines (62 sloc) 5.95 KB
Raw Blame
Open in GitHub Desktop

Old English Online

About

This is the file repository for Old English Online, an online learning platform for Old English. Uncompiled files are located in the src folder, while compiled files are located in the docs folder. Visit oldenglish.info to use the website.

Table Of Contents

Contributor's Guide

Developer's Guide

Contributor's Guide

If you want to report a bug or suggest an enhancement, perform the following steps:

  1. Create a Github account here or just login if you already have one.
  2. Navigate to the project repository on Github. It's here.
  3. Under the repository name, click Issues.
  4. Click New issue.
  5. Enter a title and description for your issue.
  6. When you are finished, click Submit new issue

How do I submit a good bug report?

  • Use a clear and descriptive title to identify what the issue is about.
  • Include all relevant information. Mention the exact page you encountered the issue on, whether you were using a desktop or mobile, what browser you were accessing the site on, and how you triggered the issue. For example, "Using Google Chrome on my laptop, I clicked the 'Check' button under the quiz on Weak Verbs II and nothing happened".
  • Include screenshots. This is especially important if you are reporting a graphical glitch or typo.

How do I submit a good feature request?

  • State what you want the feature to do. For example, 'I would like it if you could review all the flashcards you've filled out in a session so you can see which ones you got right and which you got wrong'.
  • State where you would like the feature to go. For example, 'I'd like there to be a button I could click on the flashcard modal which would bring up this information'.
  • State who you think the feature would benefit. For example, is it aimed at first time learners or postgraduate scholars?

Developer's Guide

Installing and Running

To run Old English Online locally on your machine so that you can contribute content or develop a new feature, you must perform the following steps:

  1. Create a Github account here or just login if you already have one.
  2. Download a git client, you can get the free GitKraken here.
  3. Navigate to the project repository on Github. It's here.
  4. Click the Clone or download button and copy the URL.
  5. In GitKraken, choose Clone Repo, choose From URL and paste the URL you copied from Github. This copies the repository to your machine. Take a note of where you save it as you will need to know the path to the project in step 9.
  6. Download an development environment. We recommend Visual Studio Code which you can download here.
  7. Install the most recent version of Node.js. You can download it here.
  8. Open Visual Studio Code.
  9. In Visual Studio Code, click View then Terminal to open the terminal.
  10. The folder you are in should be on the last line in the terminal. Check this path to make sure you're in the root folder of the project. If you are not, you can change which directory you're in by typing cd C:\whatever_your_filepath_is. My root folder is C:\Users\Victoria\Desktop\OldEnglishOnline so I would type cd C:\Users\Victoria\Desktop\OldEnglishOnline.
  11. Once you are in the root folder, type npm install and press Enter. Everything you need is installed automatically. This may take 2-3 minutes.
  12. When it is finished, type npm run start. This builds the project, starts the watch tasks that wait for file changes, and opens the project in your default browser. Note: Sometimes your browser is a little too fast to load the page and will instead load a white page with a GET request. Just refresh the page and the correct content will load.
  13. If the page does not load, navigate to localhost:3000 in your browser.
  14. Once the above steps are complete, you can make edits to the templates, scripts and styles in the /src/ folder, and the project will automatically refresh in the browser to show your changes once they are saved.
  15. Once you have made all your changes, save the file.
  16. Commit your changes in GitKraken by selecting Stage all changes.
  17. Push your work back up to your fork. If you're using GitKraken, you just need to click the Push button.
  18. Submit a Pull Request so that we can review your changes.
  19. An Administrator will then review and approve your changes.

License