Skip to content

Latest commit

 

History

History
145 lines (111 loc) · 3.64 KB

README.md

File metadata and controls

145 lines (111 loc) · 3.64 KB

Climbers Connect

A social media app that connects climbers to other climbers!
Website · Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Lessons Learned
  6. Contact

About The Project

Climbers Connect website

Interact with other climbers, share the climbs you've completed, rate the climbs and create a better connection to the community we all know and love.

(back to top)

Built with

  • Mongoose
  • Express.js
  • Node
  • EJS
  • Passport
  • TypeScript
  • JavaScript
  • CSS
  • Cloudinary

(back to top)

Getting Started

Installation

In order to clone a local copy of this repository, please follow the steps below.

  1. Navigate to the folder you would like to store the project
  2. Clone the repo
    git clone https://github.com/schneedotdev/climbers-connect.git
  3. Switch into the directory that was just created
    cd climbers-connect
  4. Install NPM packages
    npm install
  5. Navigate to the config folder
  6. Create a .env file there called .env
  7. Enter your MongoURI string in .env with the key DB_STRING
    DB_STRING="<Replace everything in quotes with MongoDB Connection String>"
  8. Create a session secret for express sessions called SESSION_SECRET
    SESSION_SECRET="<any string value>"
  9. Connect to your cloudinary db with the following 3 environment variables CLOUD_NAME, API_KEY, API_SECRET
    CLOUD_NAME="<cloud name here>"
    API_KEY="<api key here>"
    API_SECRET="<api secret here>"
  10. To run the application, use npm run start to run the app in a development environment

(back to top)

Usage

Coming soon...

(back to top)

Roadmap

  • Create Comment Schema
  • Add Comment Routes/Controllers
  • Add Comments to posts
  • Update FAQ
  • Add Pagination to for rendered user posts
  • Add area based chat rooms using socket.io

See the open issues for a full list of proposed features (and known issues).

(back to top)

Lessons Learned

coming soon...

(back to top)

Contact

Twitter - @schneedotdev

Email - Contact Me

(back to top)