📝 Note Sharing Application

This application is the frontend of a decoupled full-stack application that allows users to make notes and share those notes with other users.

🧱 Technologies and Versions

• React
• Node v21.5.0
• Yarn 31.22.21

✅ Onboarding to the App

• To run the app in a development environment, clone the repository and run yarn
• To spin up a local server run the command yarn start
• The application will run locally at http://localhost:3001/

⚙️ Testing

Testing is handled by React Testing Library and Jest. Run the test suite with command:

yarn test

🫧 Linting

Linting is handled by Prettier. Check for linting errors in the project by running:

yarn prettier:check:ci

Fix most lint issues in the project by running:

yarn prettier:format

🏃‍♀️ GitHub Actions

GitHub Actions will run workflows for linting and testing on each push.

🤝 Application Dependencies

• Tailwind
• Flowbite React
• React Router
• React Form Hook

🗄️ Useful Resources

A few of the many resources that helped to build this application.

• Add Tailwind to React App with Yarn
• Building A Custom Fetch Hook In React
• Prettier in GitHub Actions

🚀 Deployment

• The application is deployed on Render.com and available at this url