https://github.com/smartlogic/smartnote
SmartNote is a knowledge base system specifically geared for common development questions
https://github.com/smartlogic/smartnote
Last synced: 2 months ago
JSON representation
SmartNote is a knowledge base system specifically geared for common development questions
- Host: GitHub
- URL: https://github.com/smartlogic/smartnote
- Owner: smartlogic
- License: mit
- Created: 2020-06-05T15:14:36.000Z (about 6 years ago)
- Default Branch: main
- Last Pushed: 2023-01-05T11:35:45.000Z (over 3 years ago)
- Last Synced: 2025-03-07T02:39:51.839Z (over 1 year ago)
- Language: Elixir
- Homepage: https://smartnote.dev
- Size: 640 KB
- Stars: 1
- Watchers: 2
- Forks: 2
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# SmartNote
SmartNote is an app to track internal documentation, starting with FAQs around development.
## Setup
First install these:
- [asdf](https://asdf-vm.com/#/), which installs…
- [elixir](https://elixir-lang.org/install.html)
- [erlang](https://www.erlang.org/downloads)
- [nodejs](https://nodejs.org/en/download/)
- [PostgreSQL 12](https://www.postgresql.org/)
Once those are installed you can setup the application. Check [`.tool-versions`](.tool-versions) for needed versions if installing manually.
```bash
# This installs elixir/erlang/nodejs at the versions required
asdf plugin add elixir
asdf plugin add nodejs
asdf install
# Install elixir dependencies
mix deps.get
mix compile
# Install yarn and the rest of the javascript dependencies
npm install -g yarn
cd assets && yarn install && cd ..
# Create the database and migrate for dev & test
mix ecto.create
mix ecto.migrate
MIX_ENV=test mix ecto.migrate.reset
# Make sure tests pass
mix test
# See `Local Development` below to configure `.env.dev`
# Once complete, run the server
mix phx.server
```
## Local Development
In order to run locally, you'll need a `.env.dev` file with the following filled in:
```
GITHUB_ALLOWED_ORGANIZATIONS=comma,separated,list,of,github,orgs
GITHUB_CLIENT_ID=...
GITHUB_CLIENT_SECRET=...
```
[Create a GitHub OAuth application](https://github.com/settings/developers) and copy the client id and secret. Make sure the authorized redirect uri is `http://localhost:4000/auth/github/callback`.
## Kubernetes
To migrate on kubernetes, find a pod and exec into it and run this:
```bash
smart_note eval "SmartNote.ReleaseTasks.Migrate.run()"
```