search

FAC-11 / litlearn

The English GCSE learning app
https://litlearn.herokuapp.com/
7 stars 1 forks source link

readme

litlearn

travis badge codecov badge A web-app to help UK students prepare for their GCSE English and English Literature exams. Litlearn aims to help students anxious about the unseen text questions included in the new English GCSE exams by giving them structured practice that builds in difficulty.

Getting started

If you want to see the current site, visit us at Heroku.

If you are interested in web development and want to get this project running on your local server, here's what you need to do:

Clone or fork this repo

If you're forking this repo into your own GitHub repository to work on it yourself, click on the 'fork' button on the top of this page.

Alternatively, you can clone it to your home machine by opening up your Terminal or other Command Line Interface, navigating to the folder you would like to install this project into and typing: git clone https://github.com/FAC-11/litlearn.git

Install helper modules

To install the helper node modules, type: npm install

If you want to know what you're installing here, have a look at the package.json file under 'dependencies' and 'devDependencies'

Set up a local database

You'll need to set up a PostgreSQL database to run the project. If you're not sure how to do this, have a look here.

Once you've created a blank database, make a config.env file in your project folder to store the database information. In this, type DATABASE_URL = postgres://<username>:<password>@localhost:5432/<database name>, with the username, password and database name you created above.

To get your database up and running with the sample data we created, return to your Command Line Interface and type npm run build. If it's worked, you should see a confirmation that the database was created, starting:

db host:  localhost:5432
Database created with the result:  [ Result {
    command: 'BEGIN',

Start your server and view the site!

In your Command Line Interface, type npm run start:watch. You should see a message confirming that your server is running: App running on port 3000.

Go to your web browser of choice, visit http://localhost:3000/ and enjoy!

Running the tests

We've written tests to check our database queries and our endpoints. View them by typing npm test into your Command Line Interface.

Built with:

Contributing

This is a student project for Founders and Coders, but we'll add contributing guidelines when we're looking for collaborators after the course.

Authors

License

litlearn has been released with an ISC license

Acknowledgements