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

Cleanup and improvements prior to MVP experiments coding #69

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
Open
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
11 changes: 11 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# editorconfig.org
root = true

[*]
indent_style = space
indent_size = 2
tab_width = 2
end_of_line = lf
charset = utf-8
trim_trailing_whitespace = true
insert_final_newline = true
2 changes: 2 additions & 0 deletions .eslintignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
node_modules/
dist/
1 change: 1 addition & 0 deletions .eslintrc.js
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ module.exports = {
"vue/setup-compiler-macros": true,
},
extends: [
"standard",
"eslint:recommended",
"plugin:vue/vue3-recommended",
"plugin:prettier/recommended",
Expand Down
3 changes: 3 additions & 0 deletions .husky/pre-commit
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
yarn lint-staged

# TODO: enable after this task is complete! yarn audit:critical
4 changes: 4 additions & 0 deletions .lintstagedrc.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
module.exports = {
'*.js': 'eslint --fix',
'*.vue': 'eslint --fix'
}
8 changes: 7 additions & 1 deletion .prettierrc.json
Original file line number Diff line number Diff line change
@@ -1 +1,7 @@
{}
{
"singleQuote": true,
"trailingComma": "none",
"tabWidth": 2,
"semi": false,
"printWidth": 125
}
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,13 @@

## Description

This is the Frontend vue app which depends on the [berkmancenter/threads_server](https://github.com/berkmancenter/threads_client) repo to run.
This is the Frontend vue app which depends on the [berkmancenter/nymspace_server](https://github.com/berkmancenter/nymspace_client) repo to run.

## Installation

- Install and start [berkmancenter/threads_server](https://github.com/berkmancenter/threads_server).
- Install and start [berkmancenter/nymspace_server](https://github.com/berkmancenter/nymspace_server).
- Install `node.js` and set to version specified in `package.json` file (Consider using [nvm](https://github.com/nvm-sh/nvm))
- Install [yarn](https://classic.yarnpkg.com/lang/en/docs/install)
- Come back to this repo and `yarn install` to install packages.
- Connect backend by copying `.env.example` to `.env.local`. Make sure the ports are correctly configured in threads_server repo.
- Run `yarn dev --port 3001` and browse the app at https://localhost:3001.
Expand Down
Loading