mirror of
https://github.com/OpenSignLabs/OpenSign.git
synced 2026-09-23 18:14:55 +02:00
1 line
4.9 KiB
JavaScript
1 line
4.9 KiB
JavaScript
"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[853],{26636:(n,e,t)=>{t.r(e),t.d(e,{assets:()=>c,contentTitle:()=>r,default:()=>h,frontMatter:()=>i,metadata:()=>l,toc:()=>a});var o=t(85893),s=t(11151);const i={sidebar_position:4,title:"Installation instructions"},r="INSTALLATION INSTRUCTIONS",l={id:"contribute/INSTALLATION",title:"Installation instructions",description:"You can use our app as a cloud version from OpenSignLabs",source:"@site/docs/contribute/INSTALLATION.md",sourceDirName:"contribute",slug:"/contribute/INSTALLATION",permalink:"/docs/contribute/INSTALLATION",draft:!1,unlisted:!1,editUrl:"https://github.com/opensignlabs/opensign/tree/feat-docs/docs/docs/contribute/INSTALLATION.md",tags:[],version:"current",sidebarPosition:4,frontMatter:{sidebar_position:4,title:"Installation instructions"},sidebar:"contributeSidebar",previous:{title:"Contributing to OpenSign",permalink:"/docs/contribute/intro"},next:{title:"Community at OpenSign\u2122",permalink:"/docs/contribute/COMMUNITY"}},c={},a=[{value:"Localhost(Frontend only)",id:"localhostfrontend-only",level:2},{value:"Localhost(Docker)",id:"localhostdocker",level:2}];function d(n){const e={a:"a",code:"code",h1:"h1",h2:"h2",li:"li",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,s.a)(),...n.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(e.h1,{id:"installation-instructions",children:"INSTALLATION INSTRUCTIONS"}),"\n",(0,o.jsxs)(e.p,{children:["You can use our app as a cloud version from ",(0,o.jsx)(e.a,{href:"https://www.opensignlabs.com",children:"OpenSignLabs"})]}),"\n",(0,o.jsx)(e.p,{children:"or follow below instructions to install it on your own infrastructure."}),"\n",(0,o.jsxs)(e.ul,{children:["\n",(0,o.jsx)(e.li,{children:"Localhost(Frontend only)"}),"\n",(0,o.jsx)(e.li,{children:"Localhost(Docker)"}),"\n"]}),"\n",(0,o.jsx)(e.h2,{id:"localhostfrontend-only",children:"Localhost(Frontend only)"}),"\n",(0,o.jsx)(e.p,{children:"This is the easiest way to run the frontend application for development or testing purpose without the hassle of installing backend & DB. All the features including document upload, signing, email notifications will work seamlessly from staging backend."}),"\n",(0,o.jsxs)(e.p,{children:[(0,o.jsx)(e.strong,{children:"Warning:"})," All data, including user accounts and documents, is stored in the staging backend. This data will be erased every time there is a merge to the main branch. As a result, you may need to recreate user accounts repeatedly. If you find that login attempts are failing, it is likely because the data has been cleared due to a recent merge."]}),"\n",(0,o.jsx)(e.p,{children:"Below are the steps to follow -"}),"\n",(0,o.jsxs)(e.ul,{children:["\n",(0,o.jsxs)(e.li,{children:[(0,o.jsx)(e.a,{href:"https://help.github.com/articles/cloning-a-repository/",children:"Clone the repository"})," to your local machine using below command -","\n",(0,o.jsx)(e.pre,{children:(0,o.jsx)(e.code,{children:"git clone https://github.com/OpenSignLabs/OpenSign.git\n"})}),"\n"]}),"\n",(0,o.jsxs)(e.li,{children:["Switch to the newly created OpenSign directory.","\n",(0,o.jsx)(e.pre,{children:(0,o.jsx)(e.code,{children:"cd OpenSign\n"})}),"\n"]}),"\n",(0,o.jsxs)(e.li,{children:["Copy the .env.frontend_dev file to apps/OpenSign/.env using below command(on mac & linux). For windows use COPY command instead.","\n",(0,o.jsx)(e.pre,{children:(0,o.jsx)(e.code,{children:"cp .env.frontend_dev apps/OpenSign/.env\n"})}),"\n"]}),"\n",(0,o.jsxs)(e.li,{children:["Switch to apps/OpenSign directory.","\n",(0,o.jsx)(e.pre,{children:(0,o.jsx)(e.code,{children:"cd apps/OpenSign\n"})}),"\n"]}),"\n",(0,o.jsxs)(e.li,{children:["Install NPM packages using","\n",(0,o.jsx)(e.pre,{children:(0,o.jsx)(e.code,{children:"npm install\n"})}),"\n"]}),"\n",(0,o.jsxs)(e.li,{children:["Run the project locally using","\n",(0,o.jsx)(e.pre,{children:(0,o.jsx)(e.code,{children:"npm run start-dev\n"})}),"\n"]}),"\n"]}),"\n",(0,o.jsxs)(e.p,{children:["You should be able to access the application from ",(0,o.jsx)(e.a,{href:"http://localhost:3000",children:"http://localhost:3000"})," after this.\nCreate an account by signing-up and start contributing."]}),"\n",(0,o.jsx)(e.h2,{id:"localhostdocker",children:"Localhost(Docker)"}),"\n",(0,o.jsxs)(e.ul,{children:["\n",(0,o.jsxs)(e.li,{children:["Please refer this documentation => ",(0,o.jsx)(e.a,{href:"https://docs.opensignlabs.com/docs/self-host/docker/run-locally",children:"click here"})]}),"\n"]})]})}function h(n={}){const{wrapper:e}={...(0,s.a)(),...n.components};return e?(0,o.jsx)(e,{...n,children:(0,o.jsx)(d,{...n})}):d(n)}},11151:(n,e,t)=>{t.d(e,{Z:()=>l,a:()=>r});var o=t(67294);const s={},i=o.createContext(s);function r(n){const e=o.useContext(i);return o.useMemo((function(){return"function"==typeof n?n(e):{...e,...n}}),[e,n])}function l(n){let e;return e=n.disableParentContext?"function"==typeof n.components?n.components(s):n.components||s:r(n.components),o.createElement(i.Provider,{value:e},n.children)}}}]); |