https://github.com/abstractalgo/rosetta

A Rosetta stone for software development - learn by comparing different technologies
https://github.com/abstractalgo/rosetta

documentation learning programming rosetta

Last synced: about 1 month ago
JSON representation

A Rosetta stone for software development - learn by comparing different technologies

• Host: GitHub
• URL: https://github.com/abstractalgo/rosetta
• Owner: abstractalgo
• License: cc-by-4.0
• Created: 2021-11-15T13:44:27.000Z (about 3 years ago)
• Default Branch: master
• Last Pushed: 2022-10-20T20:10:56.000Z (about 2 years ago)
• Last Synced: 2023-02-28T14:36:42.739Z (almost 2 years ago)
• Topics: documentation, learning, programming, rosetta
• Language: TypeScript
• Homepage: https://rosetta.directory
• Size: 197 KB
• Stars: 3
• Watchers: 0
• Forks: 1
• Open Issues: 12
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
#  rosetta

A directory of various software development techniques demonstrated in multiple technologies and languages that you can compare side by side. Can be used for learning or as a reference.

## Contributing

- make changes and test things locally (see [running locally](#running-locally))

- submit your changes as new PRs

- make sure to follow the [Guildelines](#contributor-guidelines)

- all PRs will have a preview build generated automatically

- get approving reviews for your PR

- merge changes (all pushes get automatically deployed to the live website)

Currently all snippets are placed within `/public/topics` folder, in the form of `/.md`.

Add/modify snippets as Markdown (`.md`) files, exclusively. [Github flavored Markdown (GFM)](https://github.github.com/gfm/) formatting is supported.

### Adding a new tech

To add a new tech to an existing topic (i.e. add another column as an option), just create a file within `/public/topics//.md` and populate it with content. Find the `` identifiers within `/utils/techs.ts` (filenames will be matched exactly with these expected identifiers).

If you don't see a technology listed, you can modify `/utils/techs.ts` to add a new tech and its details (this will "register" it), and then do the mentioned steps to add a file snippet.

### Adding a new topic

To add a new topic, create a folder within `/public/topics` and add `about.yml` file (made based on this [topic template](/utils/TOPIC_TEMPLATE.yml)). Then add tech files inside that folder one by one.

## Running locally

This is a [Next.js](https://nextjs.org/) project ([React](https://reactjs.org) with [Typescript](https://www.typescriptlang.org)), hosted on [Vercel](https://vercel.com/). To learn more about it visit [Next.js documentation](https://nextjs.org/docs).

To run things locally, use [yarn](https://yarnpkg.com) and Next.js-provided scripts.

- install dependencies by running `yarn install`

- to start the development server use `yarn dev` (this will start listening on [http://localhost:3000](http://localhost:3000))

## Contributor guidelines

to be defined