Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Landlord, tenant, and rental listing verification service. Full stack web application built with React, Node.js, and styled with Material Design philosophy

License

Notifications You must be signed in to change notification settings

Roomlet/roomlet

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

84 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

roomlet

Roomlet

##About the Team

alt text

#Kyle Aardal alt text #Stephanie Dover

alt text
#Joshua Evans I spent the last ten years working in the music industry. I owned an independent record store for much of that time. While running my business, I was always looking for ways to solve problems, often with technical solutions. I became passionate about learning coding, realizing that there were opportunities to contribute to the future of the music industry with technological applications.

alt text #Michael Axelson Most of my experience is in the financial services industry. I am currently working on projects primarily in JavaScript, with beginner level experience in Python and SQL. I am very interested in full-stack application, using Node.js for the backend and React for the front-end.

Getting Started

NodeJS installation

NodeJS for Mac OS

Use brew to install nodeJS locally

1. Install brew... please visit the brew homepage...

Brew Homepage

2. Install NodeJS using brew with one command...
brew install node

Refer to Mac OS section of NodeJS documentation for further reference !

NodeJS documentation

NodeJS for Windows

1. Install chocolatey... please visit the brew homepage...

chocolatey Homepage

1. Install NodeJS using Chocolatey with several commands...

cinst nodejs
# or for full install with npm
cinst nodejs.install

Refer to Windows section of NodeJS documentation for further reference !

NodeJS documentation

NodeJS for Debian, Ubuntu, Linux Mint

sudo apt-get install nodejs npm

Refer to Windows section of NodeJS documentation for further reference !

NodeJS documentation

Yarn installation

Refer to Yarn documentation specific to Mac OS, Windows, Linux, and other alternatives !

Yarn Homepage

Install Mongo DB

Refer to Mongo DB documentation specific to Mac OS, Windows, Linux, and other alternatives !

Mongo DB Homepage Installation Page

Roomlet repository specific instructions (FRONT END SETUP)

Setting up the Roomlet Repository in local file directory

1. Clone the repository to local file directory

2. cd into the root level of the repository

3. Enter in the following command to initialize yarn and install node_modules

yarn install

4. Create a .env file in the root directory of the repository, containging the following information..

AUTH0_CLIENT_ID=''
AUTH0_CLIENT_DOMAIN='username.auth0.com'
NODE_ENV='dev'
AUTH0_API_TOKEN=''

5. To view the repository in the browser, enter the following command in the root directory of the repository.

yarn watch

The repository is running on port 8080 (http://localhost:8080)

Roomlet-api repository specific instructions (BACKEND API SETUP)

Setting up the Roomlet-Api Repository in local file directory

1. Clone the repository to local file directory

2. cd into the root level of the repository

3. Enter in the following command to initialize yarn and install node_modules

yarn install

4. Create a .env file in the root directory of the repository, containing the following information..

PORT=3000
CORS_ORIGINS: 'http://localhost:8080'
API_URL='http://localhost:3000'
MONGODB_URI='mongodb://localhost/dev'

5. To turn on the Mongo Database for this repository, run the following command in the root directory of the API repository

yarn run mongo-on

Special Notes...

In command prompt, open TWO windows, and follow along with specific instructions to both the Roomlet Repository and Roomlet-Api Repository. Both webpack must be compiled, as well as the Mongo Database must be running in order for the Website to achieve 100% functionality.

About

Landlord, tenant, and rental listing verification service. Full stack web application built with React, Node.js, and styled with Material Design philosophy

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •  

Languages