Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

refactor: ♻️ add initial virtualized developer environment #442

Merged
merged 4 commits into from
May 2, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions .devcontainer/Dockerfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
FROM jetpackio/devbox:latest

# Installing your devbox project
WORKDIR /code
USER root:root
RUN mkdir -p /code && chown ${DEVBOX_USER}:${DEVBOX_USER} /code
USER ${DEVBOX_USER}:${DEVBOX_USER}
COPY --chown=${DEVBOX_USER}:${DEVBOX_USER} devbox.json devbox.json
COPY --chown=${DEVBOX_USER}:${DEVBOX_USER} devbox.lock devbox.lock



RUN devbox run -- echo "Installed Packages."

RUN devbox shellenv --init-hook >> ~/.profile
16 changes: 16 additions & 0 deletions .devcontainer/devcontainer.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
{
"name": "Devbox Remote Container",
"build": {
"dockerfile": "./Dockerfile",
"context": ".."
},
"customizations": {
"vscode": {
"settings": {},
"extensions": [
"jetpack-io.devbox"
]
}
},
"remoteUser": "devbox"
}
9 changes: 9 additions & 0 deletions .envrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# Automatically sets up your devbox environment whenever you cd into this
# directory via our direnv integration:

eval "$(devbox generate direnv --print-envrc)"

# check out https://www.jetpack.io/devbox/docs/ide_configuration/direnv/
# for more details

devbox shell
29 changes: 26 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,10 @@

<br>

Neuronek is an innovative and valuable application that provides essential tools for people who want to use psychoactive substances in a safe and healthy way, regardless of their personal goals or usage patterns. The app offers personalized dosing recommendations, insights into usage patterns, a comprehensive database of substances, and a community of users who are also interested in promoting responsible usage of these substances.
Neuronek is an innovative and valuable application that provides essential tools for people who want to use psychoactive
substances in a safe and healthy way, regardless of their personal goals or usage patterns. The app offers personalized
dosing recommendations, insights into usage patterns, a comprehensive database of substances, and a community of users
who are also interested in promoting responsible usage of these substances.

<h2 align="center">Getting started</h2>

Expand All @@ -25,13 +28,33 @@ $ yarn db:push
$ yarn hephaistos # Tempoerary solution for setting up database.
```

<h2 align="center">Development</h2>

Starting a development in recommended way requires you to have [`nix`](),
[`direnv`]() and [`devbox`]() installed on your machine,
configuration in repository will automatically spin up all dependencies and set up environment for you.

```bash
direnv allow
devbox shell
pnpm i
pnpm dev
```

<h2 align="center">Technical Approach</h2>

It would be a big waste when I would not learn anything doing such project, in this case I've decided to try Emergent Design along with Evolutionary architecture and push project through a lot of iterations before releasing final solution.
It would be a big waste when I would not learn anything doing such project, in this case I've decided to try Emergent
Design along with Evolutionary architecture and push project through a lot of iterations before releasing final
solution.

<h2 align="center">Documentation</h2>

Documentation is actively maintained in [Notion](https://www.notion.so/neuronek/invite/3893a7eb16843e642e0155a1119216a84b343d3b), it's public so anyone can read it and understand vision of project. Besides that, our features, feedback and roadmap is available at [Hellonext](https://neuronek.hellonext.co/) where everybody is able to add new suggestions to application. There's no communication channels related to projects and I doubt that they will be created in future. In future feature planning may happen on [Linear](https://linear.app/neuronek) but as now GitHub issues are good way to go.
Documentation is actively maintained
in [Notion](https://www.notion.so/neuronek/invite/3893a7eb16843e642e0155a1119216a84b343d3b), it's public so anyone can
read it and understand vision of project. Besides that, our features, feedback and roadmap is available
at [Hellonext](https://neuronek.hellonext.co/) where everybody is able to add new suggestions to application. There's no
communication channels related to projects and I doubt that they will be created in future. In future feature planning
may happen on [Linear](https://linear.app/neuronek) but as now GitHub issues are good way to go.

<h2 align="center">Contributing</h2>

Expand Down
19 changes: 0 additions & 19 deletions apps/web/src/components/ui/icons/bell-icon.tsx

This file was deleted.

20 changes: 0 additions & 20 deletions apps/web/src/components/ui/icons/history-icon.tsx

This file was deleted.

34 changes: 34 additions & 0 deletions devbox.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
{
"$schema" : "https://raw.githubusercontent.com/jetify-com/devbox/main/.schema/devbox.schema.json" ,
"packages" : [
"nodejs@22" ,
"python@3.10" ,
"nodePackages.yalc@latest" ,
"nodePackages.pm2@latest" ,
"nodePackages.pnpm@latest" ,
"nodePackages.nodemon@latest" ,
"nodePackages.typescript@latest" ,
"nodePackages.prisma@latest" ,
"turbo@latest" ,
"act@latest" ,
"docker@latest" ,
"nodePackages.prettier" ,
"nodePackages.eslint@latest" ,
"bun@latest" ,
"starship@latest" ,
"zsh@latest"
] ,
"env" : {
"DEVBOX_COREPACK_ENABLED" : "true"
} ,
"shell" : {
"init_hook" : [
"pnpm install"
] ,
"scripts" : {
"test" : [
"echo \"Error: no test specified\" && exit 1"
]
}
}
}
Loading
Loading