diff --git a/app.json b/app.json new file mode 100644 index 00000000..3283aa71 --- /dev/null +++ b/app.json @@ -0,0 +1,12 @@ +{ + "name": "Reactive Resume", + "description": "A one-of-a-kind resume builder that's not out to get your data. Completely secure, customizable, portable, open-source and free forever.", + "website": "https://rxresu.me/", + "repository": "https://github.com/AmruthPillai/Reactive-Resume", + "logo": "https://i.imgur.com/ugpElge.png", + "keywords": [ + "react", + "resume", + "static" + ] +} \ No newline at end of file diff --git a/docs/.vuepress/config.js b/docs/.vuepress/config.js index 8c1ab944..b720d275 100644 --- a/docs/.vuepress/config.js +++ b/docs/.vuepress/config.js @@ -9,7 +9,14 @@ module.exports = { { text: 'Home', link: '/' }, { text: 'Go to App', link: 'https://rxresu.me/' }, ], - sidebar: ['/', '/features/', '/technology/', '/contributing/', '/building-from-source/'], - displayAllHeaders: true, + sidebar: [ + '/', + '/features/', + '/technology/', + '/contributing/', + '/building-from-source/', + '/deployment/', + ], + smoothScroll: true, }, }; diff --git a/docs/building-from-source/README.md b/docs/building-from-source/README.md index d78456b5..1c086a1b 100644 --- a/docs/building-from-source/README.md +++ b/docs/building-from-source/README.md @@ -1,3 +1,7 @@ +--- +title: Building from Source +--- + # Building from Source So, you would like to run the project on your local machine, or your own network server? You've come to the right place. It takes about 5-6 minutes to get the project running on your local, and this is how: diff --git a/docs/deployment/README.md b/docs/deployment/README.md new file mode 100644 index 00000000..4731d19c --- /dev/null +++ b/docs/deployment/README.md @@ -0,0 +1,26 @@ +--- +title: Deployment +--- + +# Deployment + +You've built the source code successfully and now you're on your way to deploying the app. There are some methods setup to deploy a version of the app without even having to build the source, so we'll run through all the steps here: + +## Deploying to Heroku + +Heroku is a cloud platform that lets companies build, deliver, monitor and scale apps — we're the fastest way to go from idea to URL, bypassing all those infrastructure headaches. + +[![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy) + +## Deploying to Netlify + +Used by more than 800,000 web developers and businesses, the Netlify platform provides modern build workflows, serverless functions and a global Application Delivery Network to deliver the most performant, secure and scalable websites and applications. + +[![Deploy to Netlify](https://www.netlify.com/img/deploy/button.svg)](https://app.netlify.com/start/deploy?repository=https://github.com/AmruthPillai/Reactive-Resume) + +## Deploy to Shared Hosting/VPS + +Here, you're kinda on your own as there are no one-click buttons to help you through, but it's a simple process. Once you've built the app, you can copy the contents of the `build` folder to your `public_html` folder and you will have the app running on your designated domain or IP address. + +Here is a great tutorial on how to set up a web server on your machine by DigitalOcean: +[How To Install Nginx on Ubuntu 18.04 ](https://www.digitalocean.com/community/tutorials/how-to-install-nginx-on-ubuntu-18-04)