Scribe's community portal scri.be

scri.be is the landing page and general purpose domain of the Scribe organization. Its purpose is to present Scribe's projects and provide resources for those who want to learn more about app functionality as well as join the community.

Note

The contributing section has information for those interested, with the articles and presentations in featured by also being good resources for learning more about Scribe.

Scribe apps are available on iOS, Android (planned) and Desktop (planned). For the data formatting processes see Scribe-Data.

Contents

• Contributing
• Environment Setup
• Featured By

Contributing ⇧

Scribe uses Matrix for communications. You're more than welcome to join us in our public chat rooms to share ideas, ask questions or just say hi :)

Please see the contribution guidelines if you are interested in contributing to scri.be. Work that is in progress or could be implemented is tracked in the issues and projects.

Note

Just because an issue is assigned on GitHub doesn't mean that the team isn't interested in your contribution! Feel free to write in the issues and we can potentially reassign it to you.

Those interested can further check the -next release- and -priority- labels in the issues for those that are most important, as well as those marked good first issue that are tailored for first time contributors. For those new to coding or our tech stack, we've collected links to helpful documentation pages in the contribution guidelines.

Ways to Help ⇧

• Reporting bugs as they're found 🐞
• Working on new features ✨
• Localization for the website 🌐
• Documentation for onboarding and project cohesion 📝

Road Map ⇧

The Scribe road map can be followed in the organization's project board where we list the most important issues along with their priority, status and an indication of which sub projects they're included in (if applicable).

Note

Consider joining our bi-weekly developer syncs!

Designs ⇧

The designs for Scribe are made using Figma. Those with interest in contributing can open a design issue to make suggestions! Design related issues are marked with the design label.

Environment Setup ⇧

1. First and foremost, please see the suggested IDE extensions in the dropdown below to make sure that your editor is set up properly.

Important

Suggested IDE extensions

VS Code

• bradlc.vscode-tailwindcss
• heybourn.headwind
• ms-vsliveshare.vsliveshare # for collaboration
• Vue.volar
• Vue.vscode-typescript-vue-plugin

2. To setup your development environment, first install Docker and Docker Compose.

Note

If you are new to Docker, as an alternative Scribe recommends installing Docker Desktop. Docker Desktop comes with many Docker tools and a straightforward user interface.

3. Fork the scri.be repo, clone your fork, and configure the remotes:

Note

Consider using SSH

Alternatively to using HTTPS as in the instructions below, consider SSH to interact with GitHub from the terminal. SSH allows you to connect without a user-pass authentication flow.

To run git commands with SSH, remember then to substitute the HTTPS URL, https://github.com/..., with the SSH one, git@github.com:....

• e.g. Cloning now becomes git clone git@github.com:<your-username>/scri.be.git

GitHub also has their documentation on how to Generate a new SSH key 🔑

# Clone your fork of the repo into the current directory.
git clone https://github.com/<your-username>/scri.be.git
# Navigate to the newly cloned directory.
cd scri.be
# Assign the original repo to a remote called "upstream".
git remote add upstream https://github.com/scribe-org/scri.be.git

• Now, if you run git remote -v you should see two remote repositories named:
  • origin (forked repository)
  • upstream (scri.be repository)

4. Create a .env file and start your docker images with the following:

   cp .env.example .env
   docker compose up
   # Or with new dependencies:
   # docker compose up --build

5. You can visit http://localhost:3000/ to see the development build once the container is up and running.

Note

Feel free to contact the team in the General room on Matrix if you're having problems getting your environment setup!

Tech Stack ⇧

The following are the current and planned technologies for scri.be:

Frontend

• Nuxt.js • Vue.js • TypeScript • Tailwind CSS • Headless UI

Deployment

• Docker • Netlify • Vitest (planned)

Localization

• Nuxt I18n • Transifex (planned)

Analytics

• Plausible (planned)

Note

Those new to any frameworks or technologies who want to work on their skills are more than welcome to contribute!

Featured By ⇧

Articles and Presentations on Scribe

2024

• February: Presentation slides for Scribe's participation at the Wikimedia Tech Safari Program

2023

• August: Scribe-iOS final submission report for Google Summer of Code 2023
• June: Scribe-iOS development blog post on Nested UITableViews & Apple's built-in ViewControllers in app menu for GSoC '23
• March: Presentation slides for a talk at Berlin Hack and Tell (Hack of the month winner 🏆)

2022

• August: Presentation slides for a session at the 2022 Wikimania Hackathon
• July: Presentation slides for a talk at CocoaHeads Berlin
• July: Video on Scribe for Wikimedia Celtic Knot 2022
• June: Presentation slides for a talk with the LD4 Wikidata Affinity Group
• June: Scribe featured for new developers on MediaWiki
• May: Presentation slides for Wikimedia Hackathon 2022
• March: Blog post on Scribe-iOS for Wikimedia Tech News (DE / Tweet)
• March: Presentation slides for Wikidata Data Reuse Days 2022

                             

Powered By ⇧

Contributors

Many thanks to all the scri.be contributors! 🚀

Code and Dependencies

The Scribe team would like to thank all the great software that made scri.be's development possible 💙

• Countless Nuxt modules

Wikimedia Communities