publishers news, profile settings and comments management etc.
Project designs are available on Invision App.
- Install Node.js (v9.0+ required). You can use nvm - Node Version Manager to quickly switch between Node versions.
- Install dependencies with
npm icommand - To start development server run
npm run devoryarn dev
- Git
- Node.js (v9.0+ required). You can use nvm - Node Version Manager to quickly switch between Node versions.
git clone [email protected]:vuukleteam/social.git vuukle-social
cd vuukle-social
npm install
NOTE:
- You can change
vuukle-socialto any desired folder - If you don't want to clone repo using SSH(command above) you can copy it using HTTPS (go to repository on bitbucket, click clone and select HTTPS) or you can clone repository using GUI
npm run build
to check builded version you can run
npm run start
Comming soon
We should use Semver for versioning. Will be not actively used
- Webpack configuration:
next.config.js(Details). - Environment variables:
env-config.js. - HTML template:
pages/_document.tsx. - Server configuration:
server/index.ts.
To write similar code we use following tools/techs:
- JSDoc to documentate things
- TSLint to lint typescript files. See
tslint.json. - TSLint React Lint rules related to React & JSX for TSLint. See
tslint.json. - EditorConfig to let know editors about indentation. See
.editorconfig
Api documentation is available on following link: http://119.81.0.50:5000/swagger/. This is temporary link, if it's not available, please let repository admin know to update readme and provide new url.
See LICENSE file
- Project Guidelines - A set of best practices for JavaScript projects
- React Developer Tools
- MobX Developer Tools
- Semver - Semantic Versioning
- Git Flow - Defines a strict branching model designed around the project release. This provides a robust framework for managing larger projects.