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 b1a3a246ce
2.10.10
8 hours ago
.circleci fix: missing end quote 2 months ago
.github fix: tags on load (#86) 2 months ago
client chore: update server deps 8 hours ago
public ugh, rm again until i fix it 4 weeks ago
scripts docs(deployment): note about http2 4 months ago
server chore: update server deps 8 hours ago
.editorconfig feat: v2 (#16) 4 months ago
.gitattributes feat: v2 (#16) 4 months ago
.gitignore chore: add webpack bundle analyzer 2 months ago
.npmrc feat: v2 (#16) 4 months ago
LICENSE.md license 10 months ago
README.md docs(readme): deploying docs 1 month ago
db.yml chore: update server deps 8 hours ago
docker-compose.yml feat: v2 (#16) 4 months ago
package-lock.json 2.10.10 8 hours ago
package.json 2.10.10 8 hours ago

README.md

marxist.space

CircleCI codecov Maintainability License: LGPL v3 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 description were incorrect, please change those instead.

Otherwise, add your links to the bottom of db.yml. This is the type of a resource:

interface Resource {
  href: string
  title: string
  tags: string[]
  description?: 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
    description: It's an Example # description 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.

Releasing

  • First, make sure your changes are good. You can run npm t in the project root to just run all the tests, or run npm run build in project root to run tests and build for production (important to verify if you’re making changes to the build setup or dependencies).
  • In the project root, run npm version patch, then git push origin master --follow-tags. The project will be deployed by Circle.

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).