https://github.com/project-lovelace/lovelace-website

📜 Back end and front end code for the Project Lovelace website.
https://github.com/project-lovelace/lovelace-website

django lovelace

Last synced: 7 days ago
JSON representation

📜 Back end and front end code for the Project Lovelace website.

• Host: GitHub
• URL: https://github.com/project-lovelace/lovelace-website
• Owner: project-lovelace
• License: mit
• Created: 2016-09-18T22:43:16.000Z (about 8 years ago)
• Default Branch: main
• Last Pushed: 2022-12-08T07:50:39.000Z (almost 2 years ago)
• Last Synced: 2024-08-02T16:40:52.789Z (3 months ago)
• Topics: django, lovelace
• Language: HTML
• Homepage: http://projectlovelace.net
• Size: 8.1 MB
• Stars: 29
• Watchers: 3
• Forks: 4
• Open Issues: 46
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Project Lovelace website

[![Tests](https://github.com/project-lovelace/lovelace-website/actions/workflows/ci.yml/badge.svg)](https://github.com/project-lovelace/lovelace-website/actions/workflows/ci.yml)

[Project Lovelace](http://projectlovelace.net) is a bunch of free scientific programming problems. Each problem teaches you some science like how to simulate a guitar, splice DNA, or predict the weather, and requires the use of scientific insight and some programming skills to solve. The problems get progressively harder but the goal is to learn cool science through programming (or vice versa)!

This repository holds the website frontend HTML, CSS, and Django template code which was created using Bulma as well as the server backend code which uses the Django framework.

## New problem submission guide

If you have an idea for a new problem please consider submitting a new problem, we love receiving new contributions!

We discuss new problems on Discord mostly but you can also open a GitHub issue or post on Discourse to discuss. Also feel free to ask us any questions at all!

Let us know if you're interested in submitting new problems so we can invite you to the [Project Lovelace GitHub organization](https://github.com/project-lovelace).

There are three steps to submitting a new problem:

1. Open a pull request to [lovelace-solutions](https://github.com/project-lovelace/lovelace-solutions#new-problem-submission-guide) with the solution to the problem.

2. Open a pull request to [lovelace-problems](https://github.com/project-lovelace/lovelace-problems#new-problem-submission-guide) with code to generate test cases for the problem.

3. Open a pull request to lovelace-website with the problem description, code stubs, and any visualization code. (You are here!)

### How to submit a new problem description

1. Add a new problem description to the [`src/problems/templates/problems/`](https://github.com/project-lovelace/lovelace-website/tree/main/src/problems/templates/problems) directory. It's mostly HTML but has some Django template stuff in there, but you should be able to create one by following what the other templates look like.

2. Add code stubs for the new problem in the [`src/static/code_stubs/`](https://github.com/project-lovelace/lovelace-website/tree/main/src/static/code_stubs) directory. If you're not sure what the code stub should look like, you can leave it blank (i.e. leave an empty file).

3. Add problem-specific visualization code to the [`src/static/visualization/`](https://github.com/project-lovelace/lovelace-website/tree/main/src/static/visualization) directory. This tells your browser how to render and visualize the test case results. Usually it's just text but you could get fancy and plot things with Plotly if you want.

4. Open a pull request! Once all the tests pass it can be merged.

## How to set up the website development environment

1. Make sure you have recent versions of `docker` and `docker-compose` installed.

2. Clone this repository.

3. Run `bash update_development.bash` to set up a development environment with the website locally.

4. Run `bash populate_development_env.bash` to populate the website with problems and a couple of users.

5. You should see a list of problems at `http://localhost:8000/problems/` and be able to submit solutions.

6. You should be able to log into `http://localhost:8000/admin/` and add new problems.