Reading the repo
Opening the box…
Reading the repo
Opening the box…
Assembly instructions
Sync-in · Sovereign platform for file storage, sharing, synchronization, and collaboration.
Saved setup from 5 h ago
Will it work on macOS?
CONTRIBUTING.mdWe appreciate your contributions and efforts in making this project better.
Before you contribute, please read the following guidelines to ensure a smooth collaboration.
All contributors must follow our Code of Conduct to ensure a friendly and inclusive environment.
main.main.You will need the following on your system:
The project uses npm workspaces to manage a monorepo with two main workspaces: backend and frontend.
This structure enables shared tooling, coordinated builds, and simplified dependency management.
| Workspace | Path | Technology | Purpose | |:----------|:---------:|:-----------------|:----------------------------------------| | Root | / | npm workspaces | Monorepo orchestration, shared scripts | | Backend | /backend | NestJS + Fastify | API server, business logic, data access | | Frontend | /frontend | Angular | User interface, client-side logic |
git clone git@github.com:Sync-in/server.git
cd server
Quick and simple example with docker:
sudo docker run -it -e MARIADB_DATABASE=database -e MARIADB_ROOT_PASSWORD=MySQLRootPassword -p 3306:3306 mariadb:11
cp environment/environment.dist.yaml environment/environment.yaml
[!CAUTION] Set
auth.token.access.secretandauth.token.refresh.secretto distinct, long, randomly generated values. Themysql.urlin theenvironment.yamlshould match the mariadb credentials and theapplications.files.dataPathpath should be writable.
npm ci
npm -w backend run build
[!TIP] Building the backend once is useful to generate the script used in the next step (in the
distdirectory).
npx drizzle-kit migrate --config=backend/src/infrastructure/database/configuration.ts
node dist/server/infrastructure/database/scripts/create-user.js --role admin --login admin --password admin
npm -w frontend run build:dev
npm -w backend run start:dev
Default endpoint is http://localhost:8080, you should be able to login with admin:admin
Happy coding!
npm run test run unit testsnpm run lint code lintingnpm run docker:build build the Docker imageeslint.config.mjs, .prettierrc)All translation files follow the same structure:
Translations must be added or updated in the following directories.
Used for notifications and emails.
To declare a new language:
backend/src/common/i18n.ts and add the language code to the LANG_SUPPORTED constant.backend/src/applications/notifications/i18n/ named language_region.ts (lowercase, with an underscore separating
the region).backend/src/applications/notifications/i18n/index.ts, like the other languages, and add it to the translations variable.Used for the web user interface.
To declare a new language:
frontend/src/i18n/l10n.ts and add the language code and language name to the i18nLanguageText variable.frontend/src/i18n named language-region.json, using the same language code declared previously.frontend/src/i18n/lib/bs.i18n.ts. Check if the locale exists in:frontend/src/i18n/lib/dayjs.i18n.ts. Check if the locale exists in:[!TIP] English is the default language used in the codebase.
Since translation keys are written in English, the English translation file may be missing or incomplete. This is expected.
Any other translation file can be used as a reference for the structure.
Thanks again for helping make Sync-in better! 🚀
Then run bash setup.sh. It stops at the first error and is safe to run again. Servers and tests aren't started; it lists them at the end. Read it first.
Needs Git: xcode-select --install
git clone https://github.com/Sync-in/server.git cd server
Node.js >=22.12.0
# needs nvm: brew install nvm (or https://github.com/nvm-sh/nvm) nvm install --lts
npm ci
npm run start
npm test
No reports for macOS yet.
GitManual AI Agent reads the 7 key files and writes a step-by-step guide for macOS. Once written, it's saved for everyone.