jslongtin / PlanMe

CVM: -C61

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

PLANME

Par: Finnegan Simpson et Jessika Longtin

Table des matière
  1. A propos du projet
  2. Commancer
  3. Usage
  4. Contact

A propos du projet

imagecal

PlanMe est un outil d'organisation personnel inspiré de l'application Notion. Il se veux d'etre un site web qui regroupe plusieurs facon de s'organiser comme des notes traditionelles , calandrier ,budget avec projection et autres! Il y a aussi un algorythme de suggestionn de contatcs pour vous mettre en relation avec des utilisateur qui vous ressemble. Ce projet est un projet web monté avec React.js et Node.js. Il utilise aussi une base de donnée postgresql et est deployé avec docker.

(retourner en haut)

Construit avec

React JavaScript HTML5 CSS3 NodeJS NPM Postgres Docker Express.js Markdown Shell Script Chart.js Notion React Router TailwindCSS Styled Components

(retourner en haut)

Getting Started

Cette section indique comment installer les outils nécessaire et comment se servir de notre site puisqu'il n'est pas mis en ligne pour l'instant.

Prerequisites

Liste des outils à installer pour l'installation du projet

Installation

Cette section explique comment installer le projet sur votre machine locale et comment le faire fonctionner.

  1. Cloner le repo

    git clone https://github.com/jslongtin/PlanMe.git
  2. Installer npm

  • cd dev/PlanMe
  • npm install

PAS NECESSAIRE SI NPM INSTALL FONCTIONNE

  1. commandes pour intsall individuels(optionel)
     npm install nodemon
     npm install bycriptjs react-chartjs
     npm install bycript
     npm install pg
     npm install tailwind
     npm install express --save
     npm install styled-components 
     npm install react-router-dom
     npm install react-chartjs-2
     npm install chart.js
     npm install @vitejs/plugin-react

(retourner en haut)

Utilisation

Étapes

  1. cd dev/PlanMe
  2. ouvrir docker desktop
  3. npm run dev
  • Se creer un compte utilisateur
    • imageRegister
  • modifier son compte utilisateur
  • avoir son contenu organiser par page
  • Prendre des notes classique avec du gras/sousligné/italique avec un titre
    • imageNote
  • avoir un calandrier avec son horaire
    • imagecal
  • ajouter/modifier/retirer des evenements dans son calandrier
  • planifier son bugdet avec une projection du futur
  • Ajouter des pages
  • voir ses contacts
  • voir ses contacts suggerer et les ajouter dans ses contatcs
    • imageUser`

(retourner en haut)

References

Clickez sur les differantes sections sous projet pour vous amener au bon fichier

Docker

Google could services

Projet

Backend

Autres

Contact

Nos githubs - Jessika Longtin - Finnegan Simpson

Project Link: https://github.com/jslongtin/PlanMe

(retourner en haut)

About

CVM: -C61


Languages

Language:JavaScript 86.7%Language:CSS 9.4%Language:HTML 2.1%Language:Dockerfile 1.1%Language:Batchfile 0.7%