You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
zacanger 27c8cc297f
chore: link
1 day ago
.circleci chore: switch to marxist.space over ip for deploy 1 month ago
.github docs(contributing): add notes about dev env 1 week ago
client chore: deps 2 days ago
public feat: robots and canonical link 1 month ago
scripts docs(deployment): note about http2 1 month ago
server chore: more links, slightly tighter search 1 day ago
.editorconfig feat: v2 (#16) 1 month ago
.gitattributes feat: v2 (#16) 1 month ago
.gitignore chore(deps): updates all around (#50) 1 month ago
.npmrc feat: v2 (#16) 1 month ago
LICENSE.md license 7 months ago
README.md chore: add a badge 6 days ago
db.yml chore: link 1 day ago
docker-compose.yml feat: v2 (#16) 1 month ago
package-lock.json 2.6.8 1 day ago
package.json 2.6.8 1 day ago

README.md

marxist.space

CircleCI codecov Maintainability Uptime Robot ratio (7 days) PageSpeed

A ProleSoft project.

Adding Resources

First please search db.yml to make sure what you want to add isn't already in there. If it is, and you couldn't find it because the tags were incomplete or incorrect or the title or subtitle were incorrect, please change those instead.

Otherwise, add your links to the top of db.yml under the line resources:.

This is the type of a resource:

interface Resource {
  href: string
  title: string
  subtitle?: string
  tags: string[]
  excerpts?: string[]
}

An example would be:

resources: # this line is already there, needs to stay at the top
  - href: https://example.com
    title: Example Domain
    subtitle: It's an Example # subtitle is optional
    tags:
      - best
      - website
    excerpts: # this list is optional
      - This domin is for use in illustrative examples in documents.

Developing

Prerequisites: Node LTS or Latest, npm, Docker, Docker Compose

git clone git@github.com:prolesoft/marxist.space.git
cd marxist.space
npm run install-all
npm start

You can also develop without Docker. You'll need Node LTS or Latest and npm. Note this is not recommended, running with Docker Compose is easier.

git clone git@github.com:prolesoft/marxist.space.git
cd marxist.space
npm run install-all
# Edit proxy in package.json to be http://localhost:9090
cd server
npm start
# In another terminal
cd client
npm start

Go to http://localhost:3000

Building and Running

npm run install-all
npm run build
cd server && npm start

Check out http://localhost:9090

See this doc for details on deploying, running in Docker, and running in Kubernetes.

Contributing

See CONTRIBUTING and the open issues.

There's also a mirror for those who would rather not use GitHub, and patches can be emailed directly to marxist.space@protonmail.com.

Credits and Tech

Built with React, Koa, TypeScript, Lowdb, Node, and Docker. Hosted on DigitalOcean. A portion of the front-end code is copy-pasted from Asperitas (MIT licensed).